Streaming platform CLI

Usage

Platform operations

Environments

You can set up your own environment, which will allow you to connect to Ververica/K8S operator. You need to fill properties within config/<env_name> directory. config/flink_deployment.yml is default deployment descriptor file for each environment (you can overwrite it using --file-descriptor-path flag). You can use jinja for templating (look at the tests for an example). base environment is the default environment. Others environment override parameters from base. You need to have in base or your own environment profile.yml file with given schema:

deployment_mode: <VVP|K8S_OPERATOR>
docker_registry_url: <docker_registry_url>

You need also extra file(s) with Ververica/Kubernetes configuration and optionally other configuration used for templating.

Example vvp.yml:

vvp:
  url: <ververica_url>
  namespace: <ververica_namespace>
  deployment_target: <some_deployment_target>

Example k8s.yml:

k8s:
  namespace: test_ns

For most of the command, you can pass the environment name with --env or export environmental variable as SCLI_ENV.

Deploying job

scli project deploy \
  --vvp-api-token "x§11d091jd1jd9jasd0j" \
  --docker-image-tag "${CI_COMMIT_TAG}" \
  --profile "dev"

Building job Docker image

scli project build \
  --docker-image-tag "latest"

Logging to Docker repository

scli docker login \
  --username "user" \
  --password "password" \
  --profile "dev"

Parameters--docker-image-tag is optional and has default value latest.

Providing certificates

Scli uses requests library to deploy jobs to Ververica Platform via REST Api. Currently requests does not support automatic downloading of intermediate certificates so entire chain of certificates should be present before making a http call

example:

sh -c 'CA_CERT_PATH=`python3 -c "import requests; print(requests.certs.where())"`;for CERT in certs/*; do cat ${CERT}; done >> ${CA_CERT_PATH}';

Project operations

SCLI Development

Prerequisities

pipenv

Build

make setup - Install dependencies required to build a wheel package
make cli/package - Create a wheel package

Install

make cli/install - Install a wheel package
make cli/install/force - Reinstall a wheel package

Metadata

Release files for streamingcli 2.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for streamingcli 2.0.3
File	Size	Uploaded
streamingcli-2.0.3.tar.gz	29.7 kB	Jul 25, 2023	Details

Release files / streamingcli-2.0.3.tar.gz

Download URL	streamingcli-2.0.3.tar.gz
Size	29.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`6a3844f5ee796c980e19b2c5d0574db8d2cdad043de68986dea7fa8f1c458907`
BLAKE2b-256 checksum How to use checksums	`6197bbf80047f17671c105507f9d3bad97bccea01bab556df4f568043ca959bf`
Upload date	Jul 25, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.17`