Skip to main content

Deploy Kubernetes Applications - Container & Helm Chart Management | Codiac CLI

Learn how to create and manage assets for use with Codiac.

What you'll get​

  • Create assets from Docker images or Helm charts, deploy to cabinets, and update or roll back
  • Ingress and TLS (Let's Encrypt) via CLI prompts; no YAML
  • Commands: asset create, asset deploy, asset list, asset view, asset undeploy, asset obliterate

Prerequisites​

Interactive CLI

The Codiac CLI guides you through each command interactively. You don't need to memorize flags, just run the command and the CLI prompts you for what it needs. To add ingress, just answer Y when asked Accessible from outside the cabinet during asset creation.

An asset is a workload. Codiac supports two asset types:

  1. Docker image in a public or private registry.
  2. Helm charts.
Usage and Options

Use codiac asset -h to see all the available options:

$ codiac asset -h
Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset COMMAND

TOPICS
  asset entrypoint  Removes an existing override of the image startup command for this asset (restores the
                    original ENTRYPOINT set in the image itself, as well as any image elements specified
                    using CMD)).
  asset probe       Declares the implementation of a health or readiness probe for an asset.
  asset volume      Declares a named path for mounting a volume to instances of the asset.

COMMANDS
  asset create      Creates a new asset in the given enterprise from an image that exists in a container
                    registry.
  asset edit        Changes asset attributes.
  asset entrypoint  Sets the command run on container startup (Overrides the ENTRYPOINT set in the image
                    itself, as well as any image elements specified using CMD)).
  asset get         Renders a selected type of content for an asset
  asset list        Shows the list of assets in a given enterprise.
  asset mon         Renders a selected type of content for an asset
  asset monitor     Renders a selected type of content for an asset
  asset new         Creates a new asset in the given enterprise from an image that exists in a container
                    registry.
  asset obliterate  Performs a full cascading delete of the given asset and all of its related data in
                    Codiac (eg: versions, probes, configs, tags...). NOTE: This command does NOT delete
                    anything from the image registry.  NOTE: To obliterate an asset, you must first remove
                    it from all cabinets; this command will not obliterate any asset that is currently
                    deployed.
  asset recycle     Deploys a given asset to a given cabinet.  Defaults to current version.
  asset undeploy    UN-deploys a given asset from a given cabinet.  Defaults to removing only the pod
                    deployments and leaving the service in place; set the --scorch argument to remove the
                    service.
  asset view        Renders a selected type of content for an asset
  asset where       Shows the cabinets to which the given asset is currently deployed and which version is
                    where.

Create a new asset​

  1. Use codiac asset create to create a new asset from the command line:
codiac asset create

  1. Follow the prompts to:

    1. Choose your container registry.
    2. Log into your cloud service provider.
    3. Select the container image for the asset.
    4. Port 1: Forwarding?: Configure port forwarding, if desired. The default is N.
    5. Assign another port?: Configure an additional port, if desired. The default is N.
    6. Accessible from outside the cabinet (aka: has ingress route): Enter Y to configure ingress or N if you don't want the asset to be available from the public internet.
    7. Usage: external answer Y.
    8. Host name on the inbound domain url: If you configure DNS, this value will be used as the service name for the URL.
    9. Will this asset be the base ingress against your DNS: This step is part of Codiac's strategy-based host mapping. You can only have one base ingress URL for your account. You will most likely want to reserve this for your main application. Otherwise, answer N.

  2. Verify all the parameters are correct, then enter Y to start the asset creation process.

Deploy an asset​

  1. Use codiac asset deploy to deploy the asset to the cabinet. This command defaults to the most recent version of the asset:
codiac asset deploy
  1. Follow the prompts to select the asset, cloud service provider, and cabinet.
tip

Made a mistake? Changed your mind? Use Snapshots to rollback your cabinet to an earlier version..

Deploy and watch it roll out​

Add --follow (-f) to watch the new pods come up right after the deploy:

codiac asset deploy -a my-api -u 1.4.2 -c orders --follow

Codiac first prints the equivalent asset view commands so you can re-check by hand later, then prints each pod state change and each new Kubernetes event as it happens:

Following my-api for up to 300s. To check on it yourself:
  codiac asset view -e my-company -a my-api -n prod -c orders -t status
  codiac asset view -e my-company -a my-api -n prod -c orders -t events -f
  +0s  pod    6f9c7d-x2kq            Pending (ContainerCreating)
  +6s  pod    6f9c7d-x2kq            Pending (ContainerCreating) → Running (not ready)
 +19s  pod    6f9c7d-x2kq            Running (not ready) → Ready
 +41s  pod    5b8d4c-aaaa            Ready → gone
✔ 2/2 pods ready in 41s

It stops at the first of these:

  • Every new pod is Ready. Old pods that are still shutting down don't count.
  • A new pod is stuck. Stuck means CrashLoopBackOff, ImagePullBackOff/ErrImagePull, CreateContainerConfigError, or a readiness or startup probe failing more times than its failureThreshold. The summary gives the reason and the most relevant event, for example ✖ 0/2 ready after 52s: Readiness probe failed: HTTP 503 /ready.
  • The timeout runs out. The default is 300 seconds; change it with --follow-timeout-in-seconds. The summary says what the rollout is still waiting on, for example 0/3 nodes are available: 3 Insufficient cpu.
Exit code

--follow reports pod health. It never changes the deploy's result. The command exits successfully once Kubernetes accepts the new spec, even if the pods then fail to start. To gate a pipeline on rollout health, read the summary line.

--follow works with --silent and in CI. It doesn't need a terminal, and the timeout always ends it. When you deploy by cabinet tag, it follows every matching cabinet at the same time and prefixes each line with [environment/cabinet]:

codiac asset deploy -a my-api -u 1.4.2 -c orders --follow --follow-timeout-in-seconds 120 --silent

To watch events on their own at any time, use codiac asset view -a my-api -c orders -t events -f. Helm assets don't have a single set of pods to follow, so --follow prints this events command for them.

View assets and details​

  1. Use codiac asset list to list all the assets in your enterprise.

  2. Use codiac asset view to select an asset and view its logs, configurations, status, and other details.

Edit an asset​

Use the web to edit a Codiac asset.

Update an asset​

  1. Use codiac asset deploy to update an existing asset.
codiac asset deploy
  1. Follow the prompts to select the new asset version, cloud service provider, and cabinet.

Rollback an asset​

Snapshots let you rollback to earlier versions of your cabinet. Click and drag the desired snapshot into your cabinet to rollback to that version. Use the web to rollback a Codiac cabinet.

Use the web to rollback a Codiac asset.

Remove an asset from a cabinet​

  1. Use codiac asset undeploy to remove an asset from a given cabinet.
codiac asset undeploy

Follow the prompts to choose the asset and the cabinet from which you want the asset removed.

info

This command does not affect the Kubernetes cluster. Your cloud service provider will continue to bill you until you destroy the cluster.

Delete (obliterate) an asset​

The codiac asset obliterate command:

  • Performs a full cascading delete of the given asset.
  • Deletes all of the asset's related data in Codiac, including:
    • Versions
    • Probes
    • Configs
    • Tags
  • Cannot be undone.

This command does NOT:

  • Delete anything from the image registry.
  • Affect your Kubernetes clusters.
tip

You can only delete (obliterate) assets that are not in any cabinets. If the asset you want to obliterate is in a cabinet, use codiac asset undeploy to remove the asset from its cabinet(s) first.

  1. Use codiac asset obliterate to delete the given asset its Codiac data:
codiac asset obliterate

Follow the prompts to choose the asset and confirm you want to delete it.

What's next​