Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
ce67e47
Onboarding docs (Updated PR)
paigecalvert Sep 24, 2024
5bbf5e0
edit landing page
paigecalvert Sep 24, 2024
fb945a3
edit xrefs
paigecalvert Sep 24, 2024
4dd2dad
add missing screenshots
paigecalvert Sep 24, 2024
08cd82d
remove unused image
paigecalvert Sep 24, 2024
490f494
update xrefs
paigecalvert Sep 24, 2024
500e611
remove unused partial
paigecalvert Sep 24, 2024
61f6142
onboarding edits
paigecalvert Sep 24, 2024
da41f0d
onboarding edits
paigecalvert Sep 24, 2024
be15f8c
onboarding edits
paigecalvert Sep 24, 2024
90f3d35
onboarding edits
paigecalvert Sep 24, 2024
a49aeb4
onboarding edits
paigecalvert Sep 24, 2024
56884cf
merge conflicts
paigecalvert Sep 30, 2024
456d249
merge conflicts
paigecalvert Oct 8, 2024
416ac75
fix broken links and merge conflicts
paigecalvert Oct 9, 2024
8a986c4
Apply suggestions from code review
paigecalvert Oct 10, 2024
529ae84
Apply suggestions from code review
paigecalvert Oct 10, 2024
cbd183d
edit app step and sidebar
paigecalvert Oct 10, 2024
9f2494c
edit the initial release step and fixes to helmchart topic
paigecalvert Oct 10, 2024
b40450f
edits
paigecalvert Oct 10, 2024
f1bdce7
add extensions and writing docs tasks
paigecalvert Oct 10, 2024
7a95ee0
add info about the icon format
paigecalvert Oct 10, 2024
7b27fc7
builder description updates
paigecalvert Oct 10, 2024
bf3e61b
edits
paigecalvert Oct 10, 2024
1056fa3
edits
paigecalvert Oct 11, 2024
f374c75
edits
paigecalvert Oct 11, 2024
fc7200b
edit
paigecalvert Oct 11, 2024
f87ca02
edits
paigecalvert Oct 11, 2024
4e86bfb
move embedded cluster extensions to initial release task
paigecalvert Oct 11, 2024
cf8b78e
edits
paigecalvert Oct 11, 2024
497b12b
explain the image pull secret
paigecalvert Oct 11, 2024
f1ecd9a
edit license entitlements
paigecalvert Oct 11, 2024
c450444
add helm air gap notes
paigecalvert Oct 24, 2024
8582106
update upgrade flow and screenshots
paigecalvert Oct 24, 2024
ee82863
copy edits
paigecalvert Oct 25, 2024
1974ba4
xref edits
paigecalvert Oct 25, 2024
21d4002
copy edits
paigecalvert Oct 25, 2024
2d4a56d
remove potentially confusing language about k8s operators
paigecalvert Oct 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,10 @@ pagination_next: null
<a href="/vendor/kots-faq">Replicated FAQs</a>
</li>
<li>
<a href="/vendor/replicated-onboarding">Replicated Quick Start</a>
<a href="/vendor/replicated-onboarding">Replicated Onboarding</a>
</li>
<li>
<a href="/vendor/tutorial-kots-helm-setup">Tutorials</a>
</li>
<li>
<a href="https://play.instruqt.com/embed/replicated/tracks/distributing-with-replicated?token=em_VHOEfNnBgU3auAnN">Getting Started Lab in Instruqt</a>
<a href="/vendor/tutorial-embedded-cluster-setup">Tutorials</a>
</li>
</ul>
</section>
Expand Down Expand Up @@ -141,29 +138,26 @@ pagination_next: null
<li>
<a href="intro-kots">Introduction to KOTS</a>
</li>
<li>
<a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
</li>
<li>
<a href="/vendor/helm-native-about">About Distributing Helm Charts with KOTS</a>
</li>
</ul>
<ul>
<li class="tile__header">
<img src="images/icons/k8s_installer.png" alt="installer icon"></img>
<p>Embedded Kubernetes</p>
<p>Embedded Cluster (Beta)</p>
</li>
<li>
<p>Embed Kubernetes with your application to support installations on VMs or bare metal servers.</p>
</li>
<li>
<a href="/vendor/embedded-kubernetes-overview">About Embedded Kubernetes</a>
<a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
</li>
<li>
<a href="/vendor/kurl-about">Introduction to kURL</a>
<a href="/enterprise/installing-embedded">Installing with Embedded Cluster (Beta)</a>
</li>
<li>
<a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
<a href="/vendor/tutorial-embedded-cluster-setup">Tutorial: Deploy a Helm Chart on a VM with Embedded Cluster (Beta)</a>
</li>
</ul>
</section>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Create a new release and promote it to the Unstable channel. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).
1 change: 1 addition & 0 deletions docs/partials/getting-started/_test-your-changes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Install the release to test your changes. For Embedded Cluster installations, see [Performing Udpates in Embedded Clusters](/enterprise/updating-embedded). For existing cluster installations with KOTS, see [Performing Updates in Existing Clusters](/enterprise/updating-app-manager).
2 changes: 1 addition & 1 deletion docs/partials/replicated-sdk/_dependency-yaml.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ dependencies:
version: 1.0.0-beta.25
```

For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/tags) in GitHub.
For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/releases) in GitHub.
2 changes: 1 addition & 1 deletion docs/reference/custom-resource-application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ spec:
<table>
<tr>
<th>Description</th>
<td>The icon file for the application. Used on the license upload and in various places in the Admin Console.</td>
<td>The icon file for the application. Used on the license upload, in various places in the Admin Console, and in the Download Portal. The icon can be a remote URL or a Base64 encoded image. Base64 encoded images are required to display the image in air gap installations with no outbound internet access.</td>
</tr>
<tr>
<th>Example</th>
Expand Down
129 changes: 0 additions & 129 deletions docs/vendor/distributing-workflow.md

This file was deleted.

78 changes: 39 additions & 39 deletions docs/vendor/helm-native-v2-using.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,6 @@ For more information about the HelmChart custom resource, including the unique r

After you complete the tasks in this topic to configure the `kots.io/v1beta2` HelmChart custom resource, you can migrate any existing installations that were deployed with `kots.io/v1beta1` with `useHelmInstall: true` to use `kots.io/v1beta2` instead. For more information, see [Migrating Existing Installations to HelmChart v2](helm-v2-migrate).

## HelmChart v1 and v2 Differences

The `kots.io/v1beta2` HelmChart custom resource has the following differences from `kots.io/v1beta1`:

<table>
<tr>
<th>HelmChart v1beta2</th>
<th>HelmChart v1beta1</th>
<th>Description</th>
</tr>
<tr>
<td><code>apiVersion: kots.io/v1beta2</code></td>
<td><code>apiVersion: kots.io/v1beta1</code></td>
<td><code>apiVersion</code> is updated to <code>kots.io/v1beta2</code></td>
</tr>
<tr>
<td><code>releaseName</code></td>
<td><code>chart.releaseName</code></td>
<td><code>releaseName</code> is a top level field under <code>spec</code></td>
</tr>
<tr>
<td>N/A</td>
<td><code>helmVersion</code></td>
<td><code>helmVersion</code> field is removed</td>
</tr>
<tr>
<td>N/A</td>
<td><code>useHelmInstall</code></td>
<td><code>useHelmInstall</code> field is removed</td>
</tr>
</table>

## Workflow

To support installations with the `kots.io/v1beta2` HelmChart custom resource, do the following:
Expand Down Expand Up @@ -271,7 +239,11 @@ spec:

### Add Backup Labels for Snapshots

The Replicated snapshots feature requires the following labels on all resources in your Helm chart that you want to be included in the backup:
:::note
The Replicated [snapshots](snapshots-overview) feature for backup and restsore is supported only for existing cluster installations with KOTS. Snapshots are not support for installations with Embedded Cluster. For more information about disaster recovery for installations with Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery.mdx).
:::

The snapshots feature requires the following labels on all resources in your Helm chart that you want to be included in the backup:
* `kots.io/backup: velero`
* `kots.io/app-slug: APP_SLUG`, where `APP_SLUG` is the slug of your Replicated application.

Expand Down Expand Up @@ -308,14 +280,42 @@ spec:
kots.io/app-slug: repl{{ LicenseFieldValue "appSlug" }}
```

### Support Local Image Registries for Online Installations {#local-registries}
### Support Local Image Registries {#local-registries}

Local image registries are required for KOTS installations in air gapped environments. Also, users in online environments can optionally push images to a local registry. For more information about how users configure a local image registry with KOTS, see [Using Private Registries](/enterprise/image-registry-settings).

To support the use of local registries for online installations with version `kots.io/v1beta2` of the HelmChart custom resource, you must provide the necessary values in the builder field to render the Helm chart with all of the necessary images so that KOTS knows where to pull the images from to push them into the local registry.
To support the use of local registries with version `kots.io/v1beta2` of the HelmChart custom resource, provide the necessary values in the builder field to render the Helm chart with all of the necessary images so that KOTS knows where to pull the images from to push them into the local registry.

For more information about how to configure the `builder` key, see [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_.
For more information about how to configure the `builder` key, see [Packaging Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles) and [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_.

:::note
If you already configured the `builder` key previously to support air gap installations, then you can use the same configuration in your HelmChart custom resource to support the use of local registries for online installations. No additional configuration is required.
:::
## HelmChart v1 and v2 Differences

The `kots.io/v1beta2` HelmChart custom resource has the following differences from `kots.io/v1beta1`:

<table>
<tr>
<th>HelmChart v1beta2</th>
<th>HelmChart v1beta1</th>
<th>Description</th>
</tr>
<tr>
<td><code>apiVersion: kots.io/v1beta2</code></td>
<td><code>apiVersion: kots.io/v1beta1</code></td>
<td><code>apiVersion</code> is updated to <code>kots.io/v1beta2</code></td>
</tr>
<tr>
<td><code>releaseName</code></td>
<td><code>chart.releaseName</code></td>
<td><code>releaseName</code> is a top level field under <code>spec</code></td>
</tr>
<tr>
<td>N/A</td>
<td><code>helmVersion</code></td>
<td><code>helmVersion</code> field is removed</td>
</tr>
<tr>
<td>N/A</td>
<td><code>useHelmInstall</code></td>
<td><code>useHelmInstall</code> field is removed</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion docs/vendor/kots-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Releases that support installation with KOTS include the manifests required by K

In addition to the KOTS manifests, releases that support installation with Embedded Cluster also include the Embedded Cluster Config. The Embedded Cluster Config defines aspects of the cluster that will be provisioned and also sets the version of KOTS that will be installed.

For more information, see [Onboarding with KOTS](/vendor/distributing-workflow) and [Using Embedded Cluster](/vendor/embedded-overview).
For more information, see [Using Embedded Cluster](/vendor/embedded-overview).

### Can I use my own branding?

Expand Down
Loading