Skip to content

Remove helm only release #2665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Remove helm only release #2665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8c62e49
Remove Helm-only release option
paigecalvert Sep 18, 2024
70fc6e2
edits
paigecalvert Sep 18, 2024
96bfd00
Remove Helm-Only release type
paigecalvert Sep 19, 2024
69f6db1
edits
paigecalvert Sep 19, 2024
8c5da75
edits
paigecalvert Sep 19, 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
19 changes: 0 additions & 19 deletions docs/reference/replicated-cli-release-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ Create a new release using a collection of application manifest files and/or one
replicated release create --yaml-dir YAML_DIR [flags]
```

```bash
replicated release create --chart HELM_CHART [flags]
```

:::note
Additional flags returned by `--help` that are not supported by Replicated are omitted from the table below.
:::
Expand All @@ -30,11 +26,6 @@ Additional flags returned by `--help` that are not supported by Replicated are o
<td>path</td>
<td><p>The local directory containing multiple YAML manifest files for a release. <strong>(Required)</strong></p><p><ChartYamlDirReqs/></p></td>
</tr>
<tr>
<td><code>--chart</code></td>
<td>string</td>
<td><p>The path to the Helm chart for a release.<strong>(Required)</strong></p><p><ChartYamlDirReqs/></p></td>
</tr>
<tr>
<td><code>--promote</code></td>
<td>string</td>
Expand Down Expand Up @@ -75,16 +66,6 @@ replicated release create --yaml-dir ./manifests
• SEQUENCE: 58
```

### `--chart`

```bash
replicated release create --chart=my-chart-1.0.0.tgz

• Reading chart from my-chart-1.0.0.tgz ✓
• Creating Release ✓
• SEQUENCE: 58
```

### `--promote`

```bash
Expand Down
34 changes: 4 additions & 30 deletions docs/vendor/releases-about.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,44 +63,18 @@ The following describes each of the channel settings:

This section provides additional information about releases, including details about release promotion, properties, sequencing, and versioning.

### Release Types
### Release Files

You can create the following types of releases in the Vendor Portal:
A release contains your application files as well as the manifests required to install the application with the Replicated installers ([Replicated Embedded Cluster](/vendor/embedded-overview) and [Replicated KOTS](../intro-kots)).

* **Helm-only Releases**: A release that contains one or more Helm charts. Helm-only releases can be installed with the Helm CLI only. For more information, see [Installing with Helm](install-with-helm).
The application files in releases can be Helm charts and/or Kubernetes manifests. However, Replicated strongly recommends that all applications are packaged with Helm. Releases for Helm applications can be installed with Embedded Cluster and KOTS, or with the Helm CLI. For more information, see [About Packaging Applications](/vendor/distributing-overview#about-packaging-applications).

* **KOTS Releases**: A release that contains your application files as well as the manifests required to install the application with Replicated KOTS. The application files in KOTS releases can be Helm charts and/or Kubernetes manifests. KOTS releases that contain one or more Helm charts can be installed with KOTS or the Helm CLI. For more information, see [Introduction to KOTS](../intro-kots).

The following shows the Helm-only and KOTS release options that appear in the **Create release** dropdown in the Vendor Portal:

<img alt="create a release dropdown" src="/images/create-release-dropdown.png" width="450px"/>

[View a larger version of this image](/images/create-release-dropdown.png)

### Promotion
### Release Promotion

Each release is promoted to one or more channels. While you are developing and testing releases, Replicated recommends promoting to a channel that does not have any real customers assigned, such as the default Unstable channel. When the release is ready to be shared externally with customers, you can then promote to a channel that has the target customers assigned, such as the Beta or Stable channel.

A release cannot be edited after it is promoted to a channel. This means that you can test a release on an internal development channel, and know with confidence that the same release will be available to your customers when you promote it to a channel where real customers are assigned.

#### Promoting KOTS-Only and Helm CLI-Only Releases {#kots-helm-releases}

<KotsEntitlement/>

To prevent KOTS or Helm CLI-only customers from accessing a release that they cannot install, Replicated enforces the following release promotion rules:

* A release must contain the required KOTS manifests to be promoted to a channel where one or more KOTS customers are assigned.

<img width="400px" alt="Release without the required manifests blocked from promotion" src="/images/release-promotion-kots-customers.png"/>

[View a larger version of this image](/images/release-promotion-kots-customers.png)

* A release must contain at least one Helm chart to be promoted to a channel where one or more Helm CLI-only customers are assigned.

<img width="400px" src="/images/release-promotion-helm-customers.png" alt="Release with no helm charts blocked from being promoted"/>

[View a larger version of this image](/images/release-promotion-helm-customers.png)

### Properties

Each release has properties. You define release properties when you promote a release to a channel. You can edit release properties at any time from the channel **Release History** page in the Vendor Portal. For more information, see [Edit Release Properties](releases-creating-releases#edit-release-properties) in _Managing Releases with the Vendor Portal_.
Expand Down
28 changes: 2 additions & 26 deletions docs/vendor/releases-creating-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can use the Replicated CLI to create a release from a local directory that c

To create and promote a release:

1. (Helm Charts Only) If your release contains any Helm charts:
1. If your release contains any Helm charts:

1. Package each Helm chart as a `.tgz` file. See [Packaging a Helm Chart for a Release](/vendor/helm-install-release).

Expand All @@ -47,7 +47,7 @@ To create and promote a release:
mv wordpress-1.3.5.tgz manifests
```

1. (KOTS Only) In the same directory that contains the release files, add a HelmChart custom resource for each Helm chart in the release. See [Configuring the HelmChart Custom Resource](helm-native-v2-using).
1. In the same directory that contains the release files, add a separate KOTS HelmChart custom resource for each Helm chart in the release. See [Configuring the HelmChart Custom Resource](helm-native-v2-using).

1. Lint the application manifest files and ensure that there are no errors in the YAML:

Expand Down Expand Up @@ -111,27 +111,3 @@ To create and promote a release:
```
replicated release ls
```

## Create a Release With One Helm Chart Only

For applications that contain only one Helm chart, you can use the `--chart` flag to create a release.

To create a release that contains one Helm chart:

1. Package the chart as a `.tgz` file. See [Packaging a Helm Chart for a Release](/vendor/helm-install-release).

1. Create and promote the release:

```bash
replicated release create --chart=CHART_ARCHIVE --promote=CHANNEL
```

Where:
* `CHART_ARCHIVE` is the Helm chart `.tgz` file. For example, `--chart=my-chart-1.0.0.tgz`.
* `CHANNEL` is the channel ID or case sensitive name of the channel.

1. Verify that the release was promoted to the target channel:

```
replicated release ls
```
21 changes: 5 additions & 16 deletions docs/vendor/releases-creating-releases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,15 @@ To create and promote a release in the Vendor Portal:

[View a larger version of this image](/images/release-create-new.png)

1. If a drop down is displayed, select one of the following options:
* **Create Helm-only release**: Create a release with one or more Helm charts. Supports installations with the Helm CLI only.
* **Create KOTS release**: Create a release that supports installations with Replicated KOTS. KOTS releases can contain Kubernetes manifests and one or more Helm charts. KOTS releases that contain Helm charts can also be installed with the Helm CLI.
1. Add files to the release. This includes your application files (like Helm charts or Kubernetes manifests) as well as the manifests required to install with the Replicated installers (like Embedded Cluster, KOTS, or kURL).

If no drop down is displayed, continue to the next step.

1. Add your files to the release:
* **Helm-only**: For Helm-only releases, follow the steps in the **Add the Replicated SDK to your Helm Chart** dialog to package your chart and upload a `.tgz` chart archive.

<img src="/images/upload-helm-chart-modal.png" alt="upload helm chart dialog" width="550px"/>

[View a larger version of this image](/images/upload-helm-chart-modal.png)

* **KOTS**: For KOTS releases, drag and drop your release files to the file directory in the YAML editor. You can also click the plus icon to add a new, untitled YAML file.
You can either drag and drop files to the file directory in the YAML editor or click the plus icon to add a new, untitled YAML file.

For any Helm charts that you add, in the **Select Installation Method** dialog, select the version of the HelmChart custom resource that KOTS will use to install the chart. kots.io/v1beta2 is recommended. For more information about the HelmChart custom resource, see [Configuring the HelmChart Custom Resource](helm-native-v2-using).
For any Helm charts that you add, in the **Select Installation Method** dialog, select the version of the HelmChart custom resource that KOTS will use to install the chart. kots.io/v1beta2 is recommended. For more information about the HelmChart custom resource, see [Configuring the HelmChart Custom Resource](helm-native-v2-using).

<img src="/images/helm-select-install-method.png" alt="select installation method dialog" width="550px"/>
<img src="/images/helm-select-install-method.png" alt="select installation method dialog" width="550px"/>

[View a larger version of this image](/images/helm-select-install-method.png)
[View a larger version of this image](/images/helm-select-install-method.png)

1. Click **Save release**. This saves a draft that you can continue to edit until you promote it.

Expand Down
Loading