Generating Manifests and Secrets

Kustomize (Default, Aspir8 managed deployments)

Navigate to your Aspire project's AppHost directory, and run:

aspirate generate

This command (by default) will also build selected projects, and push the containers to the registry (if specified), or the local docker daemon. Builds can be skipped by passing the --skip-build flag.

Your manifests will be in the ./aspirate-output directory by default.

Compose

The output format of the manifest can also be changed to compose to generate a lightweight deployment (docker/podman compose). To generate a docker compose deployment, run:

aspirate generate --output-format compose

Your docker-compose file will be at the path ./aspirate-output/docker-compose.yaml directory by default.

When using the --output-format compose flag, you can also build certain dockerfiles using the compose file. This will skip the build and push in Aspirate. To do this, include the --compose-build flag one or more times.

aspirate generate --output-format compose --compose-build hamburger --compose-build fries

This will build the hamburger and fries dockerfiles using the compose file.

Compose is what's classed as an "Ejected Deployment" and is not managed by Aspirate when you run it.

Helm Chart

You also have the option of generating a helm chart by changing the output format to helm. To generate a helm chart, run:

aspirate generate --output-format helm

Helm supports secrets, just like kustomize does, and so you will have to unlock them if you are moving between kustomize and helm.

a Helm chart is what's classed as an "Ejected Deployment" and is not managed by Aspirate when you run it.

Cli Options (Optional)

Option	Alias	Environmental Variable Counterpart	Description
--project-path	-p	`ASPIRATE_PROJECT_PATH`	The path to the aspire project.
--aspire-manifest	-m	`ASPIRATE_ASPIRE_MANIFEST_PATH`	The aspire manifest file to use
--output-path	-o	`ASPIRATE_OUTPUT_PATH`	The path to the output directory. Defaults to `./aspirate-output`
--skip-build		`ASPIRATE_SKIP_BUILD`	Skips build and Push of containers.
--disable-state		`ASPIRATE_DISABLE_STATE`	Disable aspirate state management.
--namespace		`ASPIRATE_NAMESPACE`	Generates a Kubernetes Namespace resource, and applies the namespace to all generated resources. Will be used at deployment time.
--skip-final	-sf	`ASPIRATE_SKIP_FINAL_KUSTOMIZE_GENERATION`	Skips The final generation of the kustomize manifest, which is the parent top level file
--container-image-tag	-ct	`ASPIRATE_CONTAINER_IMAGE_TAG`	The Container Image Tag to use as the fall-back value for all containers.
--container-registry	-cr	`ASPIRATE_CONTAINER_REGISTRY`	The Container Registry to use as the fall-back value for all containers.
--container-repository-prefix		`ASPIRATE_CONTAINER_REPOSITORY_PREFIX`	The Container Repository Prefix to use as the fall-back value for all containers.
--container-builder		`ASPIRATE_CONTAINER_BUILDER`	The Container Builder: can be `docker` or `podman`. The default is `docker`.
--image-pull-policy		`ASPIRATE_IMAGE_PULL_POLICY`	The image pull policy to use for all containers in generated manifests. Can be `Always`, `Never` or `IfNotPresent`. For your local docker desktop cluster - use `IfNotPresent`
--disable-secrets		`ASPIRATE_DISABLE_SECRETS`	Disables secrets management features.
--output-format		`ASPIRATE_OUTPUT_FORMAT`	Sets the output manifest format. Defaults to `kustomize`. Can be `kustomize`, `helm` or `compose`.
--runtime-identifier		`ASPIRATE_RUNTIME_IDENTIFIER`	Sets the runtime identifier for project builds. Defaults to `linux-x64`.
--secret-password		`ASPIRATE_SECRET_PASSWORD`	If using secrets, or you have a secret file - Specify the password to decrypt them
--non-interactive		`ASPIRATE_NON_INTERACTIVE`	Disables interactive mode for the command
--private-registry		`ASPIRATE_PRIVATE_REGISTRY`	Enables usage of a private registry - which will produce image pull secret.
--private-registry-url		`ASPIRATE_PRIVATE_REGISTRY_URL`	The url for the private registry
--private-registry-username		`ASPIRATE_PRIVATE_REGISTRY_USERNAME`	The username for the private registry. This is required if passing `--private-registry`.
--private-registry-password		`ASPIRATE_PRIVATE_REGISTRY_PASSWORD`	The password for the private registry. This is required if passing `--private-registry`.
--private-registry-email		`ASPIRATE_PRIVATE_REGISTRY_EMAIL`	The email for the private registry. This is purely optional and will default to `aspirate@aspirate.com`.
--include-dashboard		`ASPIRATE_INCLUDE_DASHBOARD`	Boolean flag to specify if the Aspire dashboard should also be included in deployments.
--compose-build			Can be included one or more times to set certain dockerfile resource building to be handled by the compose file. This will skip build and push in aspirate.
--launch-profile	-lp	`ASPIRATE_LAUNCH_PROFILE`	The launch profile to use when building the Aspire Manifest.
--replace-secrets		`ASPIRATE_REPLACE_SECRETS`	The secret state will be completely reinitialised, prompting for a new password. All input values and secrets will be re generated / prompted, and stored in the state.

Last modified: 18 May 2024