From 94037a4eee8ad2d8a79ff45b84922154a4affb55 Mon Sep 17 00:00:00 2001 From: Levon Tikoyan Date: Mon, 16 Nov 2026 13:12:25 -0500 Subject: [PATCH] docs(native-helm): document deployments with prebuilt images --- documentation-metadata.json | 6 ++ documentation-style-baseline.json | 10 +-- public/llms.txt | 4 +- .../docs/features/native-helm-deployment.mdx | 72 ++++++++++++++----- src/pages/docs/schema/helm.mdx | 26 ++++++- 5 files changed, 91 insertions(+), 27 deletions(-) diff --git a/documentation-metadata.json b/documentation-metadata.json index 4d23161a..d442e3a4 100644 --- a/documentation-metadata.json +++ b/documentation-metadata.json @@ -114,6 +114,12 @@ }, "notes": "All four Sites access-control implementing PRs merged to main and deployed to production. Live-verified end to end: owner-only private access, distinct denied-vs-missing responses on the management API, the CLI's visibility/create/list/get/update/extend/delete commands, the shared-apex opt-in, stable Site ID and content URL across visibility and content changes, and the intentional full downgrade path." }, + "2026-11-16-native-helm-prebuilt-images": { + "verifiedOn": "2026-11-16", + "sources": { + "lifecycle": "af30aac8df5a0daf8d2cd3aa902a4abd3a02e23e" + } + }, "2026-10-09-sites-restore-released": { "verifiedOn": "2026-10-09", "sources": { diff --git a/documentation-style-baseline.json b/documentation-style-baseline.json index 9fa6abf2..313503c5 100644 --- a/documentation-style-baseline.json +++ b/documentation-style-baseline.json @@ -1,6 +1,6 @@ { "schemaVersion": 3, - "updatedOn": "2026-10-12", + "updatedOn": "2026-11-16", "references": { "canonical": "ASD-STE100 Issue 9", "canonicalRules": [ @@ -183,8 +183,8 @@ "/docs/features/native-helm-deployment": { "file": "src/pages/docs/features/native-helm-deployment.mdx", "profile": "asd-ste100", - "reviewedOn": "2026-07-25", - "sha256": "a58acbf6c95124f944ec8c910d4d4f25b79d14dd3923bc353182190d143e81fb" + "reviewedOn": "2026-11-16", + "sha256": "1944a7b41c78aac823b3b0364f7593839d8e86927c7cadcfa14cc700a274da7f" }, "/docs/features/secrets": { "file": "src/pages/docs/features/secrets.mdx", @@ -357,8 +357,8 @@ "/docs/schema/helm": { "file": "src/pages/docs/schema/helm.mdx", "profile": "asd-ste100", - "reviewedOn": "2026-07-25", - "sha256": "8e15742511246d8df0a91df004ccbd5b376fa9add9ec5bf1f8123cf0832e9a1d" + "reviewedOn": "2026-11-16", + "sha256": "0a7eccf5dd844bcd09f9ac7f5b815ebac2d1d970ca9996885ac60c3a8a4aa7a4" }, "/docs/schema/overview": { "file": "src/pages/docs/schema/overview.mdx", diff --git a/public/llms.txt b/public/llms.txt index 20190796..704f142e 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -28,7 +28,7 @@ This index is generated from the human documentation. Follow the linked page for - [Build metadata links](https://uselifecycle.com/docs/features/build-metadata-links.md): Add administrator-managed links to Environment details using build environment variables as templates. _(audience: application-developer, platform-operator, administrator; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [Webhooks](https://uselifecycle.com/docs/features/webhooks.md): Run Codefresh pipelines or Kubernetes Jobs after an Environment deploys, fails, or is torn down. _(audience: application-developer, platform-operator; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [Service Dependencies](https://uselifecycle.com/docs/features/service-dependencies.md): Understand Service dependencies, their effects, and configuration. _(audience: application-developer, platform-operator; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ -- [Native Helm deployment](https://uselifecycle.com/docs/features/native-helm-deployment.md): Deploy Services with Helm directly in Kubernetes without an external CI/CD deployment pipeline. _(audience: application-developer, platform-operator; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ +- [Native Helm deployment](https://uselifecycle.com/docs/features/native-helm-deployment.md): Deploy Services with Helm directly in Kubernetes without an external CI/CD deployment pipeline. _(audience: application-developer, platform-operator; last verified: 2026-11-16; baseline: 2026-11-16-native-helm-prebuilt-images)_ - [Cloud secrets](https://uselifecycle.com/docs/features/secrets.md): Reference External Secrets Operator values from Lifecycle Services and native Helm deployments. _(audience: application-developer, platform-operator; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [Environment expiration and cleanup](https://uselifecycle.com/docs/features/environment-ttl.md): Understand how Lifecycle cleans up pull-request environments and expires API-created environments. _(audience: application-developer, platform-operator, administrator; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [API-created Environments](https://uselifecycle.com/docs/features/api-environments.md): Create branch-based Lifecycle Environments without a pull request. Then, track, extend, redeploy, or tear them down. _(audience: api-user, application-developer; last verified: 2026-10-09; baseline: 2026-10-09-sites-restore-released)_ @@ -60,7 +60,7 @@ This index is generated from the human documentation. Follow the linked page for - [Webhook configuration](https://uselifecycle.com/docs/schema/webhooks.md): Configure webhooks that start automated actions after Environment events. _(audience: application-developer; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [GitHub Service](https://uselifecycle.com/docs/schema/github.md): Build and deploy Services from GitHub repositories with Docker. _(audience: application-developer; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [Docker Service](https://uselifecycle.com/docs/schema/docker.md): Deploy pre-built Docker images for databases, caches, and other infrastructure components. _(audience: application-developer; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ -- [Helm Service](https://uselifecycle.com/docs/schema/helm.md): Deploy Services with local, OCI, or public Helm charts. _(audience: application-developer; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ +- [Helm Service](https://uselifecycle.com/docs/schema/helm.md): Deploy Services with local, OCI, or public Helm charts. _(audience: application-developer; last verified: 2026-11-16; baseline: 2026-11-16-native-helm-prebuilt-images)_ - [Codefresh Service](https://uselifecycle.com/docs/schema/codefresh.md): Trigger external Codefresh pipelines for deployment and teardown. _(audience: application-developer; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [Aurora Restore Service](https://uselifecycle.com/docs/schema/aurora-restore.md): Make an AWS Aurora point-in-time copy for an ephemeral Environment. _(audience: application-developer; last verified: 2026-07-24; baseline: 2026-07-24-comprehensive-audit)_ - [Configuration Service](https://uselifecycle.com/docs/schema/configuration.md): Deploy configuration-only Services for feature flags and shared configuration. _(audience: application-developer; last verified: 2026-08-01; baseline: 2026-08-01-configuration-schema-fix)_ diff --git a/src/pages/docs/features/native-helm-deployment.mdx b/src/pages/docs/features/native-helm-deployment.mdx index 0b261c45..33cba827 100644 --- a/src/pages/docs/features/native-helm-deployment.mdx +++ b/src/pages/docs/features/native-helm-deployment.mdx @@ -4,8 +4,8 @@ description: Deploy Services with Helm directly in Kubernetes without an externa audience: - application-developer - platform-operator -lastVerified: "2026-07-24" -verificationBaseline: "2026-07-24-comprehensive-audit" +lastVerified: "2026-11-16" +verificationBaseline: "2026-11-16-native-helm-prebuilt-images" contentProfile: asd-ste100 tags: - helm @@ -99,26 +99,62 @@ services: Use paths relative to the checked-out repository. If the chart path or value file is missing, the deployment fails before Helm can apply the release. +## Deploy a chart with prebuilt images + +For a local chart that specifies existing image references, set +`helm.skipImageBuild` to `true`: + +```yaml filename="lifecycle.yaml" +version: "1.0.0" + +services: + - name: "gateway" + helm: + repository: "docs-example/gateway-config" + branchName: "main" + deploymentMethod: "native" + skipImageBuild: true + chart: + name: "./charts/gateway" + valueFiles: + - "charts/gateway/values-preview.yaml" +``` + +Set `deploymentMethod` to `native` explicitly. The installation default does +not satisfy this requirement. Do not include `helm.docker` for this Service. + +With this option, Lifecycle ignores inherited Docker settings for this +Service. The chart or its values must supply the image references. + +Lifecycle still resolves the chart revision, checks out the repository, and +deploys the chart. If Lifecycle cannot resolve a local chart revision, the +deployment fails. + +To let Lifecycle build images again, remove `skipImageBuild` or set it to +`false`. See [Image build control](/docs/schema/helm#image-build-control) for +the option requirements and default behavior. + ## Configuration reference These Service fields control a native Helm deployment: -| Field | Purpose | -| ------------------------------------ | ----------------------------------------------- | -| `helm.deploymentMethod` | Select `native` or `ci` deployment | -| `helm.version` | Select the Helm version | -| `helm.args` | Add Helm arguments for this Service | -| `helm.repository` | Select the chart source repository | -| `helm.branchName` | Select the chart source branch | -| `helm.chart.name` | Set a chart name or relative chart path | -| `helm.chart.repoUrl` | Set the repository URL for a public chart | -| `helm.chart.version` | Select the chart version | -| `helm.chart.values` | Add `key=value` settings | -| `helm.chart.valueFiles` | Add value files from the checked-out repository | -| `helm.nativeHelm.image` | Override the Helm runner image | -| `helm.nativeHelm.postRenderer` | Configure a post-renderer for this Service | -| `helm.nativeHelm.defaultArgs` | Set fallback Helm arguments for this Service | -| `helm.nativeHelm.defaultHelmVersion` | Set a fallback Helm version for this Service | +| Field | Purpose | +| ------------------------------------ | ------------------------------------------------- | +| `helm.deploymentMethod` | Select `native` or `ci` deployment | +| `helm.skipImageBuild` | Skip image builds for charts with prebuilt images | +| `helm.version` | Select the Helm version | +| `helm.args` | Add Helm arguments for this Service | +| `helm.repository` | Select the chart source repository | +| `helm.branchName` | Select the chart source branch | +| `helm.chart.name` | Set a chart name or relative chart path | +| `helm.chart.repoUrl` | Set the repository URL for a public chart | +| `helm.chart.version` | Select the chart version | +| `helm.chart.values` | Add `key=value` settings | +| `helm.chart.valueFiles` | Add value files from the checked-out repository | +| `helm.nativeHelm.image` | Override the Helm runner image | +| `helm.nativeHelm.postRenderer` | Configure a post-renderer for this Service | +| `helm.nativeHelm.defaultArgs` | Set fallback Helm arguments for this Service | +| `helm.nativeHelm.defaultHelmVersion` | Set a fallback Helm version for this Service | Service configuration overrides matching installation defaults. If an operator manages a field centrally, get the approved value before you override it. diff --git a/src/pages/docs/schema/helm.mdx b/src/pages/docs/schema/helm.mdx index f0b99262..4fbf043a 100644 --- a/src/pages/docs/schema/helm.mdx +++ b/src/pages/docs/schema/helm.mdx @@ -3,8 +3,8 @@ title: Helm Service description: Deploy Services with local, OCI, or public Helm charts. audience: - application-developer -lastVerified: "2026-07-24" -verificationBaseline: "2026-07-24-comprehensive-audit" +lastVerified: "2026-11-16" +verificationBaseline: "2026-11-16-native-helm-prebuilt-images" contentProfile: asd-ste100 tags: - schema @@ -230,6 +230,27 @@ Array of Helm values in `key=value` format. Array of value file paths relative to the repository root. +## Image build control + +### skipImageBuild + +Optional boolean. The default is `false`. + +When the chart uses prebuilt images, set `skipImageBuild` to `true`. This +option requires explicit `deploymentMethod: native` and no Service-level +`helm.docker` configuration. It ignores inherited Docker settings for that +Service. + +The chart or its values must supply image references. Lifecycle still +resolves the chart revision and deploys the chart. An unresolved local chart +revision fails the deployment. + +Omitting `skipImageBuild` or setting it to `false` preserves the existing +image build behavior for local and organization charts. + +See [Deploy a chart with prebuilt images](/docs/features/native-helm-deployment#deploy-a-chart-with-prebuilt-images) +for a complete example. + ## Docker configuration The optional `docker` section defines how to build a custom image. Its @@ -284,6 +305,7 @@ init container has the fields from `docker.app`. | `args` | string | No | More Helm arguments | | `version` | string | No | Helm CLI version | | `deploymentMethod` | string | No | `"native"` or `"ci"` | +| `skipImageBuild` | boolean | No | Skip native Helm image builds. Default: `false` | | `envLens` | boolean | No | Enable the Environment Lens ingress banner | | `grpc` | boolean | No | Enable gRPC behavior for the Helm Service | | `disableIngressHost` | boolean | No | Disable Lifecycle's generated ingress host |