Zalando Deploy CLI
This CLI provides an opinionated, high-level wrapper for the “Autobahn” deployment API:
It only provides high-level commands
Only support what CI/CD pipelines need
Low-level access to Kubernetes provided by zkubectl
It uses Mustache for templating
Familiar to Zalando users: we already use it in Senza
Language-agnostic: users could switch to other tools without changing their manifests
Steps required by CI/CD Pipeline
Apply stateful resources
Cloud Formation templates
Kubernetes manifests
Should be possible for a whole directory
Create Kubernetes deployment
Switch “traffic” / scale deployments pod by pod
Needs to check pod “readyness”
Delete old deployments
Scale deployment (manually triggered)
Why another CLI?
The CI/CD pipeline could also call the “Autobahn” deployment API directly, but:
CI/CD pipeline (Jenkinsfile) would contain a lot of code and logic to interact with Autobahn API directly
Hard to test interaction with Autobahn API without running CI/CD (Jenkins)
No standard templating for Kubernetes manifests — first approach relied on another 3rd party tool (sigil)
Switching to another CI/CD would require reimplementing logic from Jenkinsfile
Usage
All commands interacting with the “Autobahn” deployment API either need the --execute flag (for immediate approval and execution) or additional calls to approve and execute.
$ sudo pip3 install -U zalando-deploy-cli
$ zdeploy configure \
--deploy-api=https://deploy-api.example.org \
--aws-account=aws:7.. \
--aws-region=eu-central-1 \
--kubernetes-cluster=aws:7..:kube-1
$ zdeploy apply ./apply/my-service.yaml --execute \
application=kio version=cd53 release=12
$ zdeploy create-deployment deployment.yaml kio cd53 12 --execute
$ zdeploy wait-for-deployment kio cd53 12
$ zdeploy switch-deployment kio cd53 12 2/10 --execute
$ zdeploy wait-for-deployment kio cd53 12
$ zdeploy switch-deployment kio cd53 12 3/10 --execute
$ # ..
$ zdeploy switch-deployment kio cd53 12 10/10 --execute
$ zdeploy delete-old-deployments kio cd53 12 --execute
$ zdeploy scale-deployment kio cd53 12 15 --execute # manual scaling
You can also just use the Mustache template interpolation manually:
$ zdeploy render-template my-manifest.yaml foo=bar var2=123
Configure for Cluster
You can automatically set Kubernetes Cluster specific configuration using the cluster’s alias:
$ zdeploy configure-for-cluster ALIAS
New configuration:
aws_account: aws:7..
kubernetes_api_server: https://kube-1.example.org
kubernetes_cluster: aws:7..:kube-1
If you don’t have zkubectl configured you also need to provide the Cluster Registry URL:
$ zdeploy configure-for-cluster --cluster-registry-url https://registry.example.org ALIAS
Metadata
Release files for zalando-deploy-cli 1.0.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| zalando-deploy-cli-1.0.10.tar.gz | 18.0 kB | Without provenance | Details for zalando-deploy-cli-1.0.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| zalando_deploy_cli-1.0.10-py3-none-any.whl | Python 3 | none | any | Details for zalando_deploy_cli-1.0.10-py3-none-any.whl |
Total release size: 43.6 kB
Release files / zalando-deploy-cli-1.0.10.tar.gz
| Download URL | zalando-deploy-cli-1.0.10.tar.gz |
|---|---|
| Size | 18.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3111c74eb0b8600b7753c53075b45d3d94bec838d9d3906c7b35ea7e54a21548
|
|
BLAKE2b-256 checksum How to use checksums |
fea008dc3a4ca04f4db3a063049905757c918d9d7408eba7df7696652500fe5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / zalando_deploy_cli-1.0.10-py3-none-any.whl
| Download URL | zalando_deploy_cli-1.0.10-py3-none-any.whl |
|---|---|
| Size | 25.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d04d9d6727c2f3c18a329f3cb508d2c42b45671e65455bf57e6fdc2a984c8d89
|
|
BLAKE2b-256 checksum How to use checksums |
e7b4909515df0c6abf8e55f968f24d394cfe24837b3a198ae2c885f7b64c8f71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for zalando-deploy-cli 1.0.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.