Skip to main content

Manage Assets

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

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:

i. Choose your container registry.

ii. Log into your cloud service provider.

iii. Select the container image for the asset.

iv. Name for the asset within the enterprise: The name to use for the asset in the Codiac web and CLI management. Defaults to the name of the container image.

v. Default port number to assign this asset when deploying to a cabinet: The port on which you want to serve content for the asset. Defaults to port 1, but you may want to choose port 80 for most web-based applications.

vi. Allow external requests (aka: has ingress route): Enter Y if you want Codiac to provision ingress for the asset. Enter N if you don't want Codiac to provision ingress for the asset.

  1. 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.

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.

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.