tanzu apps workload apply

This topic tells you about the Tanzu Apps CLI tanzu apps workload apply command.

Use the tanzu apps workload apply command to create and update workloads that are deployed in a cluster through a supply chain.

The tanzu apps workload apply and tanzu apps workload create commands have the same behavior and flags with the following exceptions:

The tanzu apps workload create command fails if a workload with the same name preexists on the target cluster.
the update-strategy flag is only applicable to the tanzu apps workload apply command. The update-strategy flag is not applicable to the tanzu apps workload create command.

Default view

In the output of the tanzu apps workload apply command, the specification for the workload is shown in YAML file format.

Example

In the first section, the definition of workload is displayed. It’s followed by a dialog box asking whether the workload should be created or updated. In the last section, if a workload is created or updated, some hints are displayed about the next steps.

Workload Apply flags

`--annotation`

Sets the annotations to be applied to the workload. To specify more than one annotation set the flag multiple times. These annotations are passed as parameters to be processed in the supply chain.

Example

To delete an annotation, use - after its name.

Example

`--app`

This is the application the workload is part of. This is part of the workload metadata section.

Example

```bash tanzu apps workload apply tanzu-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-tag tap-1.3 --type web --app tanzu-java-web-app Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | app.kubernetes.io/part-of: tanzu-java-web-app 7 + | apps.tanzu.vmware.com/workload-type: web 8 + | name: tanzu-app 9 + | namespace: default 10 + |spec: 11 + | source: 12 + | git: 13 + | ref: 14 + | tag: tap-1.3 15 + | url: https://github.com/vmware-tanzu/application-accelerator-samples 16 + | subPath: tanzu-java-web-app ? Do you want to create this workload? Yes Created workload "tanzu-app" To see logs: "tanzu apps workload tail tanzu-app" To get status: "tanzu apps workload get tanzu-app" ```

`--build-env`

Sets environment variables to use in the build phase by the build resources in the supply chain.

Example

To delete a build environment variable, use - after its name.

Example

`--debug`

Sets the parameter variable debug to true in the workload.

Example

`--dry-run`

Prepares all the steps to submit the workload to the cluster and stops before sending it, showing an output of the final structure of the workload.

Example

```bash tanzu apps workload apply tanzu-java-web-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-tag tap-1.3 --type web --build-env JAVA_VERSION=1.8 --param-yaml server=$'port: 8080\nmanagement-port: 8181' --dry-run --- apiVersion: carto.run/v1alpha1 kind: Workload metadata: creationTimestamp: null labels: apps.tanzu.vmware.com/workload-type: web name: tanzu-java-web-app namespace: default spec: build: env: - name: JAVA_VERSION value: "1.8" params: - name: server value: management-port: 8181 port: 8080 source: git: ref: tag: tap-1.3 url: https://github.com/vmware-tanzu/application-accelerator-samples subPath: tanzu-java-web-app status: supplyChainRef: {} ```

`--env`

Sets the environment variables to the workload so the supply chain resources can used it to deploy the workload application.

Example

`--file`, `-f`

Sets the workload specification file to create the workload. This comes from any other workload specification passed by flags to the command set or overrides what is in the file. Another way to use this flag is by using - in the command to receive workload definition through stdin. See Working with YAML Files section for an example.

Example

`--git-repo`

The Git repository from which the workload is created. You can specify --git-tag, or --git-commit.

`--git-branch`

The branch in a Git repository from where the workload is created. This is specified with a commit or a tag.

Example

`--git-tag`

The tag in a Git repository from which the workload is created. This is used with --git-commit or --git-branch.

`--git-commit`

Commit in Git repository from where the workload is resolved. Can be used with --git-branch or git-tag.

Example

`--image`

Sets the OSI image to be used as the workload application source instead of a Git repository

Example

`--label`

Sets the label to be applied to the workload. To specify more than one label, set the flag multiple times.

Example

To unset labels, use - after their name.

Example

`--limit-cpu`

The maximum CPU the workload pods are allowed to use.

Example

`--limit-memory`

The maximum memory the workload pods are allowed to use.

Example

`--live-update`

Enable this to deploy the workload once, save changes to the code, and see those changes reflected in the workload running on the cluster.

Example

An example with a Spring Boot application: 1. Clone the repository by running: ```console git clone https://github.com/vmware-tanzu/application-accelerator-samples ``` 1. Change into the `tanzu-java-web-app` directory. 1. In `Tiltfile`, first change the `SOURCE_IMAGE` variable to use your registry and project. 1. At the very end of the file add: ```bash allow_k8s_contexts('your-cluster-name') ``` 2. Inside the directory, run: ```bash tanzu apps workload apply tanzu-java-web-app --live-update --local-path . -s gcr.io/my-project/tanzu-java-web-app-live-update -y ``` Expected output: ```bash The files and directories listed in the .tanzuignore file are being excluded from the uploaded source code. Publishing source in "." to "gcr.io/my-project/tanzu-java-web-app-live-update"... Published source Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | name: tanzu-java-web-app 6 + | namespace: default 7 + |spec: 8 + | params: 9 + | - name: live-update 10 + | value: "true" 11 + | source: 12 + | image: gcr.io/my-project/tanzu-java-web-app-live-update:latest@sha256:3c9fd738492a23ac532a709301fcf0c9aa2a8761b2b9347bdbab52ce9404264b Created workload "tanzu-java-web-app" To see logs: "tanzu apps workload tail tanzu-java-web-app" To get status: "tanzu apps workload get tanzu-java-web-app" ``` 3. Run Tilt to deploy the workload. ```bash tilt up Tilt started on http://localhost:10350/ v0.23.6, built 2022-01-14 (space) to open the browser (s) to stream logs (--stream=true) (t) to open legacy terminal mode (--legacy=true) (ctrl-c) to exit Tilt started on http://localhost:10350/ v0.23.6, built 2022-01-14 Initial Build • (Tiltfile) Loading Tiltfile at: /path/to/repo/tanzu-java-web-app/Tiltfile Successfully loaded Tiltfile (1.500809ms) tanzu-java-w… │ tanzu-java-w… │ Initial Build • tanzu-java-web-app tanzu-java-w… │ WARNING: Live Update failed with unexpected error: tanzu-java-w… │ Cannot extract live updates on this build graph structure tanzu-java-w… │ Falling back to a full image build + deploy tanzu-java-w… │ STEP 1/1 — Deploying tanzu-java-w… │ Objects applied to cluster: tanzu-java-w… │ → tanzu-java-web-app:workload tanzu-java-w… │ tanzu-java-w… │ Step 1 - 8.87s (Deploying) tanzu-java-w… │ DONE IN: 8.87s tanzu-java-w… │ tanzu-java-w… │ tanzu-java-w… │ Tracking new pod rollout (tanzu-java-web-app-build-1-build-pod): tanzu-java-w… │ ┊ Scheduled - (…) Pending tanzu-java-w… │ ┊ Initialized - (…) Pending tanzu-java-w… │ ┊ Ready - (…) Pending ... ```

`--local-path`

Sets the path to a source in the local machine from where the workload creates an image to use as an application source. The local path can be a directory, a JAR, a ZIP, or a WAR file. Java/Spring Boot compiled binaries are also supported. This flag must be used with --source-image flag.

If Java/Spring compiled binary is passed instead of source code, the command will take less time to apply the workload since the build pack will skip the compiling steps and start uploading the image.

When working with local source code, you can exclude files from the source code to be uploaded within the image by creating a file .tanzuignore at the root of the source code. The .tanzuignore file contains a list of file paths to exclude from the image including the file itself. The directories must not end with the system path separator (/ or \). If the file contains directories that are not in the source code, they are ignored. Lines starting with a # hashtag are also ignored.

`--maven-artifact`

This artifact is an output of a Maven project build. This flag must be used with --maven-version and --maven-group.

Example

`--maven-group`

This group identifies the project across all other Maven projects.

`--maven-type`

This specifies the type of artifact that the Maven project produces. This flag is optional and is set by default as jar by the supply chain.

`--maven-version`

Definition of the current version of the Maven project.

`--source-image`, `-s`

Registry path where the local source code is uploaded as an image.

Example

```bash tanzu apps workload apply spring-pet-clinic --local-path /home/user/workspace/spring-pet-clinic --source-image gcr.io/spring-community/spring-pet-clinic --type web ? Publish source in "/home/user/workspace/spring-pet-clinic" to "gcr.io/spring-community/spring-pet-clinic"? It may be visible to others who can pull images from that repository Yes The files and/or directories listed in the .tanzuignore file are being excluded from the uploaded source code. Publishing source in "/home/user/workspace/spring-pet-clinic" to "gcr.io/spring-community/spring-pet-clinic"... Published source Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | apps.tanzu.vmware.com/workload-type: web 7 + | name: spring-pet-clinic 8 + | namespace: default 9 + |spec: 10 + | source: 11 + | image:gcr.io/spring-community/spring-pet-clinic:latest@sha256:5feb0d9daf3f639755d8683ca7b647027cfddc7012e80c61dcdac27f0d7856a7 ? Do you want to create this workload? (y/N) ```

`--namespace`, `-n`

Specifies the namespace in which the workload is created or updated in.

Example

`--param`

Additional parameters to be sent to the supply chain, the value is sent as a string. For complex YAML and JSON objects use --param-yaml.

Example

To unset parameters, use - after their name.

Example

`--param-yaml`

Additional parameters to be sent to the supply chain, the value is sent as a complex object.

Example

To unset parameters, use - after their name.

Example

`--registry-ca-cert`

Refers to the path of the self-signed certificate needed for the custom/private registry. This is also populated with a default value through environment variables. If the environment variable TANZU_APPS_REGISTRY_CA_CERT is set, it’s not necessary to use it in the command.

See Environment variables with default values for the updated supported environment variables.

Example

```bash tanzu apps workload apply my-workload --local-path . -s registry.url.nip.io/my-package/my-image --type web --registry-ca-cert path/to/cacert/mycert.nip.io.crt --registry-username my-username --registry-password my-password ? Publish source in "." to "registry.url.nip.io/my-package/my-image"? It may be visible to others who can pull images from that repository Yes Publishing source in "." to "registry.url.nip.io/my-package/my-image"... Published source Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | apps.tanzu.vmware.com/workload-type: web 7 + | name: my-workload 8 + | namespace: default 9 + |spec: 10 + | source: 11 + | image: registry.url.nip.io/my-package/my-image:latest@sha256:caeb7e3a0e3ae0659f74d01095b6fdfe0d3c4a12856a15ac67ad6cd3b9e43648 ? Do you want to create this workload? (y/N) ```

`--registry-password`

If credentials are needed, the user name and password values are set through the --registry-password flag. The value of this flag can also be specified through TANZU_APPS_REGISTRY_PASSWORD.

`--registry-token`

Used for token authentication in the private registry. This flag is set as TANZU_APPS_REGISTRY_TOKEN environment variable.

`--registry-username`

Often used with --registry-password to set private registry credentials. Can be provided using TANZU_APPS_REGISTRY_USERNAME environment variable to avoid setting it every time in the command.

`--request-cpu`

Refers to the minimum CPU the workload pods request to use.

Example

`--request-memory`

Refers to the minimum memory the workload pods are requesting to use.

Example

`--service-account`

Refers to the service account to associate with the workload. A service account provides an identity for a workload object.

Example

To unset a service account, pass empty string.

Example

```bash tanzu apps workload apply tanzu-java-web-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-branch main --type web --service-account "" Update workload: ... 6, 6 | apps.tanzu.vmware.com/workload-type: web 7, 7 | name: tanzu-java-web-app 8, 8 | namespace: default 9, 9 |spec: 10 - | serviceAccountName: petc-serviceaccount 11, 10 | source: 12, 11 | git: 13, 12 | ref: 14, 13 | branch: main ... ? Really update the workload "tanzu-java-web-app"? (y/N) ```

`--service-ref`

Binds a service to a workload to provide the information from a service resource to an application.

For more information, see Tanzu Application Platform documentation.

Example

To delete service binding, use the service name followed by -.

Example

`--sub-path`

Defines which path is used as the root path to create and update the workload.

Example

- Git repository ```bash tanzu apps workload apply subpathtester --git-repo https://github.com/path-to-repo/my-repo --git-branch main --type web --sub-path my-subpath Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | apps.tanzu.vmware.com/workload-type: web 7 + | name: subpathtester 8 + | namespace: default 9 + |spec: 10 + | source: 11 + | git: 12 + | ref: 13 + | branch: main 14 + | url: https://github.com/path-to-repo/my-repo 15 + | subPath: my-subpath ? Do you want to create this workload? (y/N) ``` - Local path - In the directory of the project you want to create the workload from ```bash tanzu apps workload apply my-workload --local-path . -s gcr.io/my-registry/my-workload-image --sub-path subpath_folder ? Publish source in "." to "gcr.io/my-registry/my-workload-image"? It may be visible to others who can pull images from that repository Yes Publishing source in "." to "gcr.io/my-registry/my-workload-image"... Published source Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | name: myworkload 6 + | namespace: default 7 + |spec: 8 + | source: 9 + | image: gcr.io/my-registry/my-workload-image:latest@sha256:f28c5fedd0e902800e6df9605ce5e20a8e835df9e87b1a0aa256666ea179fc3f 10 + | subPath: subpath_folder ? Do you want to create this workload? (y/N) ```

`--tail`

Prints the logs of the workload creation in every step.

Example

```bash tanzu apps workload apply tanzu-java-web-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-branch main --type web --tail Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | apps.tanzu.vmware.com/workload-type: web 7 + | name: tanzu-java-web-app 8 + | namespace: default 9 + |spec: 10 + | source: 11 + | git: 12 + | ref: 13 + | branch: main 14 + | url: https://github.com/vmware-tanzu/application-accelerator-samples 15 + | subPath: tanzu-java-web-app ? Do you want to create this workload? Yes Created workload "tanzu-java-web-app" To see logs: "tanzu apps workload tail tanzu-java-web-app" To get status: "tanzu apps workload get tanzu-java-web-app" Waiting for workload "tanzu-java-web-app" to become ready... + tanzu-java-web-app-build-1-build-pod › prepare tanzu-java-web-app-build-1-build-pod[prepare] Build reason(s): CONFIG tanzu-java-web-app-build-1-build-pod[prepare] CONFIG: tanzu-java-web-app-build-1-build-pod[prepare] + env: tanzu-java-web-app-build-1-build-pod[prepare] + - name: BP_OCI_SOURCE tanzu-java-web-app-build-1-build-pod[prepare] + value: main/d381fb658cb435a04e2271ca85bd3e8627a5e7e4 tanzu-java-web-app-build-1-build-pod[prepare] resources: {} tanzu-java-web-app-build-1-build-pod[prepare] - source: {} tanzu-java-web-app-build-1-build-pod[prepare] + source: tanzu-java-web-app-build-1-build-pod[prepare] + blob: tanzu-java-web-app-build-1-build-pod[prepare] + url: http://source-controller.flux-system.svc.cluster.local./gitrepository/default/tanzu-java-web-app/1c4cf82e499f7e46da182922d4097908d4817320.tar.gz ... ... ... ```

`--tail-timestamp`

Prints the logs of the workload creation in every step adding the time in which the log is occurring.

Example

```bash tanzu apps workload apply tanzu-java-web-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-branch main --type web --tail-timestamp Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | apps.tanzu.vmware.com/workload-type: web 7 + | name: tanzu-java-web-app 8 + | namespace: default 9 + |spec: 10 + | source: 11 + | git: 12 + | ref: 13 + | branch: main 14 + | url: https://github.com/vmware-tanzu/application-accelerator-samples 15 + | subPath: tanzu-java-web-app ? Do you want to create this workload? Yes Created workload "tanzu-java-web-app" To see logs: "tanzu apps workload tail tanzu-java-web-app" To get status: "tanzu apps workload get tanzu-java-web-app" Waiting for workload "tanzu-java-web-app" to become ready... + tanzu-java-web-app-build-1-build-pod › prepare tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.348418803-05:00 Build reason(s): CONFIG tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.364719405-05:00 CONFIG: tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.364761781-05:00 + env: tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.364771861-05:00 + - name: BP_OCI_SOURCE tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.364781718-05:00 + value: main/d381fb658cb435a04e2271ca85bd3e8627a5e7e4 tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.364788374-05:00 resources: {} tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.364795451-05:00 - source: {} tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.365344965-05:00 + source: tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.365364101-05:00 + blob: tanzu-java-web-app-build-1-build-pod[prepare] 2022-06-15T11:28:01.365372427-05:00 + url: http://source-controller.flux-system.svc.cluster.local./gitrepository/default/tanzu-java-web-app/1c4cf82e499f7e46da182922d4097908d4817320.tar.gz ... ... ... ```

`--type`

Sets the type of workload by adding the label apps.tanzu.vmware.com/workload-type, which is used as a matcher by supply chains. Use the TANZU_APPS_TYPE environment variable to have a default value for this flag.

Example

`--wait`

Holds the command until the workload is ready.

Example

```bash tanzu apps workload apply tanzu-java-web-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-tag tap-1.3 --type web --wait Update workload: ... 10, 10 | source: 11, 11 | git: 12, 12 | ref: 13, 13 | branch: main 14 + | tag: tap-1.3 14, 15 | url: https://github.com/vmware-tanzu/application-accelerator-samples 15, 16 | subPath: tanzu-java-web-app ? Really update the workload "tanzu-java-web-app"? Yes Updated workload "tanzu-java-web-app" To see logs: "tanzu apps workload tail tanzu-java-web-app" To get status: "tanzu apps workload get tanzu-java-web-app" Waiting for workload "tanzu-java-web-app" to become ready... Workload "tanzu-java-web-app" is ready ```

`--wait-timeout`

Sets a timeout to wait for the workload to become ready.

Example

```bash tanzu apps workload apply tanzu-java-web-app --git-repo https://github.com/vmware-tanzu/application-accelerator-samples --sub-path tanzu-java-web-app --git-tag tap-1.3-take1 --type web --wait --wait-timeout 1m Update workload: ... 10, 10 | source: 11, 11 | git: 12, 12 | ref: 13, 13 | branch: main 14 - | tag: tap-1.3 14 + | tag: tap-1.3-take1 15, 15 | url: https://github.com/vmware-tanzu/application-accelerator-samples 16, 16 | subPath: tanzu-java-web-app ? Really update the workload "tanzu-java-web-app"? Yes Updated workload "tanzu-java-web-app" To see logs: "tanzu apps workload tail tanzu-java-web-app" To get status: "tanzu apps workload get tanzu-java-web-app" Waiting for workload "tanzu-java-web-app" to become ready... Workload "tanzu-java-web-app" is ready ```

`--yes`, `-y`

Assumes --yes on all the survey prompts.

Example

```bash tanzu apps workload apply spring-pet-clinic --local-path/home/user/workspace/spring-pet-clinic --source-image gcr.io/spring-community/spring-pet-clinic --type web -y The files and/or directories listed in the .tanzuignore file are being excluded from the uploaded source code. Publishing source in "/Users/dalfonso/Documents/src/java/tanzu-java-web-app" to "gcr.io/spring-community/spring-pet-clinic"... Published source Create workload: 1 + |--- 2 + |apiVersion: carto.run/v1alpha1 3 + |kind: Workload 4 + |metadata: 5 + | labels: 6 + | apps.tanzu.vmware.com/workload-type: web 7 + | name: spring-pet-clinic 8 + | namespace: default 9 + |spec: 10 + | source: 11 + | image: gcr.io/spring-community/spring-pet-clinic:latest@sha256:5feb0d9daf3f639755d8683ca7b647027cfddc7012e80c61dcdac27f0d7856a7 Created workload "spring-pet-clinic" To see logs: "tanzu apps workload tail spring-pet-clinic" To get status: "tanzu apps workload get spring-pet-clinic" ```

tanzu apps workload apply

Default view

Workload Apply flags

--annotation

--app

--build-env

--debug

--dry-run

--env

--file, -f

--git-repo

--git-branch

--git-tag

--git-commit

--image

--label

--limit-cpu

--limit-memory

--live-update

--local-path

--maven-artifact

--maven-group

--maven-type

--maven-version

--source-image, -s

--namespace, -n

--param

--param-yaml

--registry-ca-cert

--registry-password

--registry-token

--registry-username

--request-cpu

--request-memory

--service-account

--service-ref

--sub-path

--tail

--tail-timestamp

--type

--wait

--wait-timeout

--yes, -y

`--annotation`

`--app`

`--build-env`

`--debug`

`--dry-run`

`--env`

`--file`, `-f`

`--git-repo`

`--git-branch`

`--git-tag`

`--git-commit`

`--image`

`--label`

`--limit-cpu`

`--limit-memory`

`--live-update`

`--local-path`

`--maven-artifact`

`--maven-group`

`--maven-type`

`--maven-version`

`--source-image`, `-s`

`--namespace`, `-n`

`--param`

`--param-yaml`

`--registry-ca-cert`

`--registry-password`

`--registry-token`

`--registry-username`

`--request-cpu`

`--request-memory`

`--service-account`

`--service-ref`

`--sub-path`

`--tail`

`--tail-timestamp`

`--type`

`--wait`

`--wait-timeout`

`--yes`, `-y`