Venafi CLI Tool reference guide¶

Usage¶

venctl command [flags]

Getting help with Venafi CLI tool commands¶

Use the following command to get information on individual venctl commands and their flags:

venctl [command] --help

Quick install/uninstall commands¶

Use these commands to install specified Venafi components into a Kubernetes cluster and remove them thereafter.

venctl components kubernetes apply¶

Install the specified Venafi components into a Kubernetes cluster.

This command applies the components specified by the provided flags and value files into a Kubernetes cluster.

Usage:

venctl components kubernetes apply [flags]

Examples:

Install cert-manager using the default approver:

venctl components kubernetes apply --cert-manager --default-approver

Install cert-manager with Approver Policy and Trust Manager:

venctl components kubernetes apply --cert-manager --approver-policy --trust-manager

Flags:

venctl components kubernetes delete¶

Delete all applied Venafi components from a Kubernetes cluster. Deletes all components previously applied using the venctl component kubernetes apply command:

Usage:

venctl components kubernetes delete [flags]

Flags:

Kubernetes Manifest tool commands¶

Use the commands to generate manifests, install and manage Venafi Kubernetes components.

venctl components kubernetes manifest generate¶

Generates a Venafi Kubernetes manifest for components.

The generated file can be used as an installation manifest by the Venafi CLI tool to install components into a Kubernetes cluster, which you can store in source control along with other infrastructure-as-code resources.

All supported components have flags to mark them for installation as well as for configuring other aspects of how the tool should be installed:

• Custom helm chart repository
• Custom image registry for inside the cluster
• Custom version
• Lists of values.yaml files which provide Helm values. For more information on the supported values for each component, see its related Helm values reference page.

Dependencies of explicitly requested components are automatically included in the manifest.

Usage:

venctl components kubernetes manifest generate [flags]

Flags:

venctl components kubernetes manifest print-versions¶

Output a list of all supported components along with their default versions.

Usage:

venctl components kubernetes manifest print-versions [flags]

venctl components kubernetes manifest tool destroy¶

Destroys and then purges releases.

Usage:

venctl components kubernetes manifest tool destroy [flags]

Flags:

venctl components kubernetes manifest tool diff¶

Diff releases defined in the state file.

Usage:

venctl components kubernetes manifest tool diff [flags]

Flags:

venctl components kubernetes manifest tool init¶

Initialize the Venafi Kubernetes Manifest tool. Performs version checking and downloads and installs Helm and other required plug-ins

Usage:

venctl components kubernetes manifest tool init [flags]

Flags:

venctl components kubernetes manifest tool sync¶

Synchronize releases defined in the state file.

Usage:

venctl components kubernetes manifest tool sync [flags]

Flags:

venctl components kubernetes manifest tool template¶

Template releases defined in the state file.

Usage:

venctl components kubernetes manifest tool template [flags]

Flags:

Service Account commands¶

Use these commands to create and manage service accounts in Venafi Control Plane.

venctl iam service-accounts agent create¶

Create a new service account that can be used by Venafi Kubernetes Agent.

Usage:

venctl iam service-accounts agent create [flags]

Example:

venctl iam service-accounts agent create --output secret --name sa-agent --api-key xyz

venctl iam service-accounts custom-integration create¶

Create a new service account for custom integrations with the Venafi Control Plane.

Usage:

venctl iam service-accounts custom-integration create [flags]

Example:

To create a new service account with the ability to create other service accounts, type:

venctl iam service-accounts custom-integration create \
    --name sa-custom-integration \
    --scopes svcaccount-write \
    --output-file svcaccount-write-credential.json \
    --api-key xyz

venctl iam service-accounts delete¶

Delete a service account from the Venafi Control Plane.

Usage:

venctl iam service-accounts delete [flags]

Example:

venctl iam service-accounts delete --name "My Service Account" --api-key xyz

venctl iam service-accounts describe¶

Provides information on a service account.

Usage:

venctl iam service-accounts describe [flags]

Example:

venctl iam service-accounts describe --api-key xyz -n myaccount --log-format json --no-prompts >> accinfo.json

venctl iam service-accounts firefly create¶

Create a service account for Venafi Firefly.

Usage:

venctl iam service-accounts firefly create [flags]

Examples:

To create a new service account that can be used by Venafi Firefly, type:

venctl iam service-accounts firefly create --name sa-firefly --api-key xyz

To export the service account credential in Kubernetes secret format, type:

venctl iam service-accounts firefly create --output secret --name sa-firefly --api-key xyz

venctl iam service-accounts list¶

Lists the service accounts in the Venafi Control Plane.

Usage:

venctl iam service-accounts list [flags]

Example:

venctl iam service-accounts list --api-key xyz --log-format json --no-prompts >> acclist.json

venctl iam service-accounts registry create¶

Create a new service account in the Venafi Control Plane for accessing container images from the Venafi OCI registry.

Usage:

venctl iam service-accounts registry create [flags]

Example:

venctl iam service-accounts registry create --name "My Service Account" --output-file "venafi-image-pull-secret.json" --owning-team "My Platform Team" --scopes "cert-manager-components" --validity 365 --api-key xyz

Cluster connection command¶

Use this command to connect a Kubernetes cluster to Venafi Control Plane.

venctl installation cluster connect¶

Connect a Kubernetes cluster to Venafi Control Plane.

Usage:

venctl installation cluster connect [flags]

Example:

venctl installation cluster connect --name "My Cluster" --api-key xyz

Flags:

Venafi CLI tool version and maintenance commands¶

Use these commands to find out which version of the Venafi CLI tool you're using, and update to the latest version.

venctl update¶

Updates the venctl binary to the latest available stable version.

Usage:

venctl update [flags]

Flags:

venctl version¶

Prints the venctl version and build information.

Usage:

venctl version [flags]

Flags:

Related links¶

• Venafi CLI tool overview
• Installing the Venafi CLI tool
• Venafi CLI tool releases