Skip to content

Latest commit

 

History

History
170 lines (134 loc) · 7.91 KB

README.md

File metadata and controls

170 lines (134 loc) · 7.91 KB
Raw

CG DevX CLI Commands

This document outlines the commands supported by the CG DevX CLI tool, which configures the CG DevX Kubernetes Internal Developer Platform (IDP) kit.

Setup

The setup command initializes and configures the reference implementation, saving intermediate states to a local file for checkpointing, allowing the command to be rerun if necessary.

Key Operations Performed:

  • Checks cloud CLI tool presence and permissions using provided profiles or access keys.
  • Validates DNS provider permissions and domain ownership.
  • Creates SSH key pairs, remote backend storage (e.g., AWS S3), and a GitOps repository under the chosen Git provider.
  • Provisions a Kubernetes cluster and associated cloud resources.

Usage Options:

  • Arguments: Command-line arguments directly.
  • Environment Variables: Via the system environment.
  • Input File: Specifying parameters in a YAML file.

Command Arguments

Name (short, full) Type Description
-e, --email TEXT Email address for alerts
-c, --cloud-provider [aws,azure] Cloud provider type
-cp, --cloud-profile TEXT Cloud account profile
-cc, --cloud-account-key TEXT Cloud account access key
-cs, --cloud-account-secret TEXT Cloud account access secret
-r, --cloud-region TEXT Cloud region
-n, --cluster-name TEXT Cluster name
-d, --dns-registrar [route53,azure_dns] DNS registrar
-dt, --dns-registrar-token TEXT DNS registrar token
-dk, --dns-registrar-key TEXT DNS registrar key
-ds, --dns-registrar-secret TEXT DNS registrar secret
-dn, --domain-name TEXT Domain name for the Kubernetes cluster
-g, --git-provider [github] Git provider
-go, --git-org TEXT Git organization name
-gt, --git-access-token TEXT Git access token
-grn, --gitops-repo-name TEXT GitOps repository name
-gtu, --gitops-template-url TEXT GitOps repository template URL
-gtu, --gitops-template-url TEXT GitOps repository template URL
-gtb, --gitops-template-branch TEXT GitOps repository template branch
-dw, --setup-demo-workload Flag Flag to set up a demo workload
-ops, --optional-services TEXT Setup optional services
-ra, --image-registry-auth TEXT Image registry auth config, JSON
-f, --config-file FILENAME File to load setup parameters from
--verbosity [DEBUG, INFO, WARNING, ERROR, CRITICAL] Logging verbosity level, defaults to CRITICAL

Available Optional Services:

  • keda
  • kubevirt
  • nvidia-gpu-operator
  • perfectscale
  • vpa

Note!: Use kebab-case for all parameter names.

When installing PerfectScale, you should set clientId and clientSecret in your secret store ( path secret/perfectscale-secret) to values provided in PerfectScale UI.

Examples

Using command arguments:

cgdevxcli setup --email [email protected] \
                --cloud-provider aws \
                --cloud-profile your-aws-cli-profile-name \
                --cluster-name cluster-name \
                --dns-registrar route53 \
                --domain-name example.com \
                --git-provider github \
                --git-org acmeinc \
                --git-access-token ghp_xxx \
                --gitops-repo-name gitops-repo-name

With optional parameters:

--image-registry-auth "{ \"docker.io\": { \"login\": \"user\", \"token\": \"token\" } }"
--optional-services keda
--optional-services vpa

Using a parameter file:

cgdevxcli setup -f path/to/your/parameters.yaml

parameters.yaml file example

email: [email protected]
cloud-provider: aws
cloud-profile: your-aws-cli-profile-name
cloud-region: eu-west-1
cluster-name: cluster-name
dns-registrar: route53
domain-name: example.com
git-provider: github
git-org: acmeinc
git-access-token: ghp_xxx
gitops-repo-name: gitops-repo-name
optional-services:
  - keda
  - vpa
image-registry-auth:
  docker.io:
    login: user
    token: token

Troubleshooting

Installation of a reference architecture is a complex process depending on multiple factors, e.g., cloud resource availability, connection speed, image registry rate limits, etc. While we do our best to handle the most common problems and provide uninterrupted experience, the setup process could still fail. If you have connectivity or resource availability errors, please try restarting the setup. It should resume from the step when it failed previously.

Destroy

This command destroys all resources created during the setup process, effectively reversing the setup. It uses local state data created during the setup.

What the destroy command deletes:

  • K8s cluster and supporting cloud resources provisioned by the CG DevX CLI
  • GitOps repository created under the Git provider of your choice
  • Remote backend storage (e.g., AWS S3) used for IaC
  • All local files created by the CG DevX CLI

Note: This process is irreversible.

Note: This operation will delete all workload repositories. If workloads have any out-of-cluster (cloud provider) resources, they will become orphaned and should be manually deleted. It is highly recommended to delete all active workloads and associated resources before destroying your installation. See more on the workload delete command with the --destroy-resources flag here.

Arguments:

Name (short, full) Type Description
--verbosity [DEBUG, INFO, WARNING, ERROR, CRITICAL] Logging verbosity level, default CRITICAL

Command snippet

cgdevxcli destroy

Troubleshooting

Some of the resources used by reference architecture are created dynamically in a run time. When doing cleanup, we are trying to destroy those temporary resources, and then all other resources created by our automation. The cleanup process could still fail. If you have any issues, please try restarting the process. If it fails to delete your K8s cluster, please try deleting Load Balancer(s) manually and restart the process. For GitHub, external action runners should be removed prior to repository deletion. If it fails to delete your GitOps repo - please check and remove runners and restart the process.