Update Application CR for ECv3 by paigecalvert · Pull Request #4045 · replicatedhq/replicated-docs

paigecalvert · 2026-05-08T17:03:12Z

No description provided.

netlify · 2026-05-08T17:03:19Z

✅ Deploy Preview for replicated-docs ready!

Name	Link
🔨 Latest commit	`9babee3`
🔍 Latest deploy log	https://app.netlify.com/projects/replicated-docs/deploys/69fe2da1a2369e00089fc31b
😎 Deploy Preview	https://deploy-preview-4045--replicated-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2026-05-08T17:03:21Z

✅ Deploy Preview for replicated-docs-upgrade ready!

Name	Link
🔨 Latest commit	`9babee3`
🔍 Latest deploy log	https://app.netlify.com/projects/replicated-docs-upgrade/deploys/69fe2da18206f20008a042dd
😎 Deploy Preview	https://deploy-preview-4045--replicated-docs-upgrade.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

github-actions · 2026-05-08T17:03:43Z

 # Application

-The Application custom resource enables features such as branding, release notes, port forwarding, dashboard buttons, app status indicators, and custom graphs.
+The Application custom resource enables branding in the customer-facing UI. For installations with KOTS in an existing cluster, it also enables other features in the Admin Console UI such as port fowarding, custom graphs, and more.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'fowarding'?

github-actions · 2026-05-08T17:03:43Z

+
+The title to use in the customer-facing UI. Typically, this is the application name.
+
+For installations with Embedded Cluster v3, the `title` is displayed in the install and upgrade wizards. For installations with Embedded Cluster v2, KOTS existing cluster, and kURL, the `title` is displayed in the Admin Console.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('is displayed').

github-actions · 2026-05-08T17:03:43Z

+
+The title to use in the customer-facing UI. Typically, this is the application name.
+
+For installations with Embedded Cluster v3, the `title` is displayed in the install and upgrade wizards. For installations with Embedded Cluster v2, KOTS existing cluster, and kURL, the `title` is displayed in the Admin Console.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('is displayed').

github-actions · 2026-05-08T17:03:43Z

+
+A file with the icon to use in the customer-facing UI. Typically, this is the application's logo.
+
+For installations with Embedded Cluster v3, the `icon` is displayed in the install and upgrade wizards. For installations with Embedded Cluster v2, KOTS existing cluster, and kURL, the `icon` is displayed in the Admin Console.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('is displayed').

github-actions · 2026-05-08T17:03:43Z

+
+A file with the icon to use in the customer-facing UI. Typically, this is the application's logo.
+
+For installations with Embedded Cluster v3, the `icon` is displayed in the install and upgrade wizards. For installations with Embedded Cluster v2, KOTS existing cluster, and kURL, the `icon` is displayed in the Admin Console.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('is displayed').

github-actions · 2026-05-08T17:03:44Z

+
+### `ports`
+
+Extra ports, in addition to the `8800` Admin Console port, that are port-forwarded when running the `kubectl kots admin-console` command. With ports specified, KOTS can establish port forwarding to simplify connections to the deployed application. When the application starts and the service is ready, the KOTS CLI prints a message in the terminal with the URL where the port-forwarded service can be accessed. For more information, see [Port Forwarding Services with KOTS](/vendor/admin-console-port-forward).


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('be accessed').

github-actions · 2026-05-08T17:03:44Z

+
+#### Limitations
+
+* Go templates are supported in the `ports.serviceName` and `ports.applicationUrl` fields only. Using Go templates in the `ports.localPort` or `ports.servicePort` fields results in an installation error similar to the following: `json: cannot unmarshal string into Go struct field ApplicationPort.spec.ports.servicePort of type int`.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('are supported').

github-actions · 2026-05-08T17:03:44Z

+
+### `targetKotsVersion`
+
+The KOTS version that is targeted by the release. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('is targeted').

github-actions · 2026-05-08T17:03:44Z

+  targetKotsVersion: "1.85.0"
+```
+
+### `minKotsVersion` (Beta)


⚠️ [vale] _{reported by reviewdog 🐶}
[Replicated.Headings] '************** (Beta)' should use sentence case.

github-actions · 2026-05-08T17:03:44Z

+
+### `minKotsVersion` (Beta)
+
+The minimum KOTS version that is required by the release. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('is required').

github-actions · 2026-05-08T18:06:21Z

+
+An array of additional namespaces as strings for KOTS to create in the cluster. For more information, see [Defining Additional Namespaces](/vendor/operator-defining-additional-namespaces).
+
+In each additional namespace, KOTS creates the application secret.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.

github-actions · 2026-05-08T18:06:21Z

+An array of additional namespaces as strings for KOTS to create in the cluster. For more information, see [Defining Additional Namespaces](/vendor/operator-defining-additional-namespaces).
+
+In each additional namespace, KOTS creates the application secret.
+KOTS ensures that the application secret has access to pull the application images, including both images that are used and any images that you add in the [`additionalImages`](#additionalimages) property.


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.Passive] In general, use active voice instead of passive voice ('are used').

github-actions · 2026-05-08T18:06:21Z

+      query: 'sum(user_signup_events_total)'
+```
+
+### `proxyRegistryDomain` (Deprecated)


⚠️ [vale] _{reported by reviewdog 🐶}
[Replicated.Headings] '******************* (Deprecated)' should use sentence case.

github-actions · 2026-05-08T18:06:21Z

+  proxyRegistryDomain: "proxy.yourcompany.com"
+```
+
+### `replicatedRegistryDomain` (Deprecated)


⚠️ [vale] _{reported by reviewdog 🐶}
[Replicated.Headings] '************************ (Deprecated)' should use sentence case.

github-actions · 2026-05-08T18:06:21Z

+
+### `minKotsVersion` (Beta)
+
+For KOTS existing cluster installations, `minKotsVersion` sets the minimum KOTS version required to deloy the given release. KOTS blocks an installation or update if the currently-deployed KOTS version is earlier than the `minKotsVersion`. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'deloy'?

github-actions · 2026-05-08T18:06:21Z

+
+### `minKotsVersion` (Beta)
+
+For KOTS existing cluster installations, `minKotsVersion` sets the minimum KOTS version required to deloy the given release. KOTS blocks an installation or update if the currently-deployed KOTS version is earlier than the `minKotsVersion`. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).


⚠️ [vale] _{reported by reviewdog 🐶}
[Replicated.Timeless] Avoid temporal words like 'currently'.

github-actions · 2026-05-08T18:21:32Z

+Depending on which Replicated installer the customer uses, this UI is either the Embedded Cluster v3 install and upgrade wizard or the Replicated Admin Console.

-There is some overlap between the Application custom resource manifest file and the [Kubernetes SIG Application custom resource](https://github.com/kubernetes-sigs/application/blob/master/docs/api.md). For example, enabling features such as [adding a button to the dashboard](/vendor/admin-console-adding-buttons-links) requires the use of both the Application and SIG Application custom resources.
+For Replicated installers that enable the Admin Console, the Application custom resource also lets you configure other aspects the Admin Console user experience,


📝 [vale] _{reported by reviewdog 🐶}
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.

Update Application CR for ECv3

6ff67c9

replicated-ci added type::docs Improvements or additions to documentation type::feature labels May 8, 2026

github-actions Bot reviewed May 8, 2026

View reviewed changes

wip

cb76bb5

github-actions Bot reviewed May 8, 2026

View reviewed changes

edits

92ddb5d

github-actions Bot reviewed May 8, 2026

View reviewed changes

address vale linter comments

7f6db66

paigecalvert marked this pull request as ready for review May 8, 2026 18:34

paigecalvert requested a review from a team as a code owner May 8, 2026 18:34

remove redundant info about different UIs

9babee3


		The title to use in the customer-facing UI. Typically, this is the application name.

		For installations with Embedded Cluster v3, the `title` is displayed in the install and upgrade wizards. For installations with Embedded Cluster v2, KOTS existing cluster, and kURL, the `title` is displayed in the Admin Console.


		A file with the icon to use in the customer-facing UI. Typically, this is the application's logo.

		For installations with Embedded Cluster v3, the `icon` is displayed in the install and upgrade wizards. For installations with Embedded Cluster v2, KOTS existing cluster, and kURL, the `icon` is displayed in the Admin Console.


		### `ports`

		Extra ports, in addition to the `8800` Admin Console port, that are port-forwarded when running the `kubectl kots admin-console` command. With ports specified, KOTS can establish port forwarding to simplify connections to the deployed application. When the application starts and the service is ready, the KOTS CLI prints a message in the terminal with the URL where the port-forwarded service can be accessed. For more information, see [Port Forwarding Services with KOTS](/vendor/admin-console-port-forward).


		#### Limitations

		* Go templates are supported in the `ports.serviceName` and `ports.applicationUrl` fields only. Using Go templates in the `ports.localPort` or `ports.servicePort` fields results in an installation error similar to the following: `json: cannot unmarshal string into Go struct field ApplicationPort.spec.ports.servicePort of type int`.


		### `targetKotsVersion`

		The KOTS version that is targeted by the release. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).


		### `minKotsVersion` (Beta)

		The minimum KOTS version that is required by the release. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).


		An array of additional namespaces as strings for KOTS to create in the cluster. For more information, see [Defining Additional Namespaces](/vendor/operator-defining-additional-namespaces).

		In each additional namespace, KOTS creates the application secret.


		### `minKotsVersion` (Beta)

		For KOTS existing cluster installations, `minKotsVersion` sets the minimum KOTS version required to deloy the given release. KOTS blocks an installation or update if the currently-deployed KOTS version is earlier than the `minKotsVersion`. For more information, see [Setting Minimum and Target Versions for KOTS](/vendor/packaging-kots-versions).

Conversation

paigecalvert commented May 8, 2026

Uh oh!

netlify Bot commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs ready!

Uh oh!

netlify Bot commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for replicated-docs-upgrade ready!

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify Bot commented May 8, 2026 •

edited

Loading

netlify Bot commented May 8, 2026 •

edited

Loading