Skip to main content

Platform Services Kubernetes Controller Common Functions

Project description

ps-k8s-ctrl-common

What does this package do

This package is a of functions that are common to all Commercial Mobility Kubernetes Configuration controllers

Setup

Clone Repo

# Make a copy of the repo
git clone git@git.viasat.com:Mobility-Engineering/ps-k8s-ctrl-common.git
# Load any submodules
cd ps-k8s-ctrl-common
git submodule update --init

Setup version.txt file (one time only)

This repo uses automatic versioning; so you will need a version.txt file. To create one (one time only), use the following command:

make version.txt

Create a virtual environment (one time, unless new packages added)

make virt-env

Generate package documentation

make documentation

The documentation is created as a web page in the pdoc folder. Open your browser at this URL: file:///(home directory for your repo)/pdoc/index.html (eg. My repo is located at /Users/snakada/git/nebula/ps/ps-k8s-ctrl-common; so I would open the browser at: file:///Users/snakada/git/nebual/ps/ps-k8s-ctrl-common/pdoc/index.html) In the left column, navigate to the ps_k8s tab to find the documentation for the PsK8s class

How to run Unit Tests

source venv/bin/activate
make unit-test

Run static analysis

make static-anaylsis

Cleanup

Remove built wheel package

make clean

Remove test docker container

make remove-container

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ps_k8s_ctrl_common-0.0.0.4.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ps_k8s_ctrl_common-0.0.0.4-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file ps_k8s_ctrl_common-0.0.0.4.tar.gz.

File metadata

  • Download URL: ps_k8s_ctrl_common-0.0.0.4.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.11

File hashes

Hashes for ps_k8s_ctrl_common-0.0.0.4.tar.gz
Algorithm Hash digest
SHA256 90a4b09447110c50f63b7c7365879d28f0f2b959e3864ff1d006375ed347be85
MD5 3c1ab0c5f64e68d5d4e581becba3b43d
BLAKE2b-256 7eadd3d09184a586555fcf6408810de02cc72d62ccc9d919cd5ad93ee9371300

See more details on using hashes here.

File details

Details for the file ps_k8s_ctrl_common-0.0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for ps_k8s_ctrl_common-0.0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 77494b9cdc30e635e0727fdc3e82fb3b748b3ae0efc1a741c660e58379d72f2a
MD5 aa60b25fbe9b6f77a43da95b7433a822
BLAKE2b-256 969a90978de45c0597f3cabc7e30dc5b2534bc7b924d29a042b78926a2369e1c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page