Skip to content

Commit

Permalink
docs(openshift): remove mirrored openshift image from Longhorn
Browse files Browse the repository at this point in the history
Longhorn 9597

Signed-off-by: Derek Su <derek.su@suse.com>
  • Loading branch information
derekbit committed Oct 9, 2024
1 parent 2495032 commit 0f532a7
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,21 @@ To deploy Longhorn on a cluster provisioned with OpenShift 4.x, some additional

Please refer to this section [Install with Helm](../../../deploy/install/install-with-helm/) first.

And then install Longhorn with setting ***openshift.enabled*** true:
Install Longhorn with the following settings:

| Setting | Value | Example |
| --- | --- | --- |
| `openshift.enabled` | `true` | N/A |
| `image.openshift.oauthProxy.repository` | Upstream image | `quay.io/openshift/origin-oauth-proxy` |
| `image.openshift.oauthProxy.tag` | Version 4.1 or later | `4.15` |

```bash
helm install longhorn longhorn/longhorn --namespace longhorn-system --create-namespace --set openshift.enabled=true
helm install longhorn longhorn/longhorn \
--namespace longhorn-system \
--create-namespace \
--set openshift.enabled=true \
--set image.openshift.oauthProxy.repository=quay.io/openshift/origin-oauth-proxy \
--set image.openshift.oauthProxy.tag=4.15
```

## Prepare A Customized Default Longhorn Disk (Optional)
Expand Down
4 changes: 2 additions & 2 deletions content/docs/1.6.4/references/helm-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ The `values.yaml` file contains items used to tweak a deployment of this chart.
| image.longhorn.supportBundleKit.tag | string | `"v0.0.33"` | Tag for the Longhorn Support Bundle Manager image. |
| image.longhorn.ui.repository | string | `"longhornio/longhorn-ui"` | Repository for the Longhorn UI image. |
| image.longhorn.ui.tag | string | `"master-head"` | Tag for the Longhorn UI image. |
| image.openshift.oauthProxy.repository | string | `"longhornio/openshift-origin-oauth-proxy"` | Repository for the OAuth Proxy image. This setting applies only to OpenShift users. |
| image.openshift.oauthProxy.tag | float | `4.14` | Tag for the OAuth Proxy image. This setting applies only to OpenShift users. Specify OCP/OKD version 4.1 or later. The latest stable version is 4.14. |
| image.openshift.oauthProxy.repository | string | `""` | Repository for the OAuth Proxy image. Specify the upstream image (for example, "quay.io/openshift/origin-oauth-proxy"). This setting applies only to OpenShift users. |
| image.openshift.oauthProxy.tag | float | `""` | Tag for the OAuth Proxy image. Specify OCP/OKD version 4.1 or later (including version 4.15, which is available at quay.io/openshift/origin-oauth-proxy:4.15). This setting applies only to OpenShift users. |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy that applies to all user-deployed Longhorn components, such as Longhorn Manager, Longhorn driver, and Longhorn UI. |

### Service Settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,36 @@ To deploy Longhorn on a cluster provisioned with OpenShift 4.x, some additional

Please refer to this section [Install with Helm](../../../deploy/install/install-with-helm/) first.

And then install Longhorn with setting ***openshift.enabled*** true:
Install Longhorn with the following settings:

| Setting | Value | Example |
| --- | --- | --- |
| `openshift.enabled` | `true` | N/A |
| `image.openshift.oauthProxy.repository` | Upstream image | `quay.io/openshift/origin-oauth-proxy` |
| `image.openshift.oauthProxy.tag` | Version 4.1 or later | `4.15` |

```bash
helm install longhorn longhorn/longhorn --namespace longhorn-system --create-namespace --set openshift.enabled=true
helm install longhorn longhorn/longhorn \
--namespace longhorn-system \
--create-namespace \
--set openshift.enabled=true \
--set image.openshift.oauthProxy.repository=quay.io/openshift/origin-oauth-proxy \
--set image.openshift.oauthProxy.tag=4.15
```

### Install With `oc` Command

You can install Longhorn on [OKD](https://www.okd.io/) clusters using the following command:
You can install Longhorn on [OKD](https://www.okd.io/) clusters as the following steps:

1. Download the longhorn-okd.yaml file:
```
wget https://raw.githubusercontent.com/longhorn/longhorn/v{{< current-version >}}/deploy/longhorn-okd.yaml
```
1. Specify the target `oauth-proxy` container image in the `longhorn-okd.yaml` file (for example, `quay.io/openshift/origin-oauth-proxy:4.15`).

1. Run the following command:
```shell
oc apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{{< current-version >}}/deploy/longhorn-okd.yaml
oc apply -f longhorn-okd.yaml
```

One way to monitor the progress of the installation is to watch pods being created in the `longhorn-system` namespace:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/1.7.2/references/helm-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ The `values.yaml` file contains items used to tweak a deployment of this chart.
| image.longhorn.supportBundleKit.tag | string | `"v0.0.37"` | Tag for the Longhorn Support Bundle Manager image. |
| image.longhorn.ui.repository | string | `"longhornio/longhorn-ui"` | Repository for the Longhorn UI image. |
| image.longhorn.ui.tag | string | `"master-head"` | Tag for the Longhorn UI image. |
| image.openshift.oauthProxy.repository | string | `"longhornio/openshift-origin-oauth-proxy"` | Repository for the OAuth Proxy image. This setting applies only to OpenShift users. |
| image.openshift.oauthProxy.tag | float | `4.14` | Tag for the OAuth Proxy image. This setting applies only to OpenShift users. Specify OCP/OKD version 4.1 or later. The latest stable version is 4.14. |
| image.openshift.oauthProxy.repository | string | `""` | Repository for the OAuth Proxy image. Specify the upstream image (for example, "quay.io/openshift/origin-oauth-proxy"). This setting applies only to OpenShift users. |
| image.openshift.oauthProxy.tag | float | `""` | Tag for the OAuth Proxy image. Specify OCP/OKD version 4.1 or later (including version 4.15, which is available at quay.io/openshift/origin-oauth-proxy:4.15). This setting applies only to OpenShift users. |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy that applies to all user-deployed Longhorn components, such as Longhorn Manager, Longhorn driver, and Longhorn UI. |

### Service Settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,36 @@ To deploy Longhorn on a cluster provisioned with OpenShift 4.x, some additional

Please refer to this section [Install with Helm](../../../deploy/install/install-with-helm/) first.

And then install Longhorn with setting ***openshift.enabled*** true:
Install Longhorn with the following settings:

| Setting | Value | Example |
| --- | --- | --- |
| `openshift.enabled` | `true` | N/A |
| `image.openshift.oauthProxy.repository` | Upstream image | `quay.io/openshift/origin-oauth-proxy` |
| `image.openshift.oauthProxy.tag` | Version 4.1 or later | `4.15` |

```bash
helm install longhorn longhorn/longhorn --namespace longhorn-system --create-namespace --set openshift.enabled=true
helm install longhorn longhorn/longhorn \
--namespace longhorn-system \
--create-namespace \
--set openshift.enabled=true \
--set image.openshift.oauthProxy.repository=quay.io/openshift/origin-oauth-proxy \
--set image.openshift.oauthProxy.tag=4.15
```

### Install With `oc` Command

You can install Longhorn on [OKD](https://www.okd.io/) clusters using the following command:
You can install Longhorn on [OKD](https://www.okd.io/) clusters as the following steps:

1. Download the longhorn-okd.yaml file:
```
wget https://raw.githubusercontent.com/longhorn/longhorn/v{{< current-version >}}/deploy/longhorn-okd.yaml
```
1. Specify the target `oauth-proxy` container image in the `longhorn-okd.yaml` file (for example, `quay.io/openshift/origin-oauth-proxy:4.15`).

1. Run the following command:
```shell
oc apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{{< current-version >}}/deploy/longhorn-okd.yaml
oc apply -f longhorn-okd.yaml
```

One way to monitor the progress of the installation is to watch pods being created in the `longhorn-system` namespace:
Expand Down
4 changes: 2 additions & 2 deletions content/docs/1.8.0/references/helm-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ The `values.yaml` file contains items used to tweak a deployment of this chart.
| image.longhorn.supportBundleKit.tag | string | `"v0.0.37"` | Tag for the Longhorn Support Bundle Manager image. |
| image.longhorn.ui.repository | string | `"longhornio/longhorn-ui"` | Repository for the Longhorn UI image. |
| image.longhorn.ui.tag | string | `"master-head"` | Tag for the Longhorn UI image. |
| image.openshift.oauthProxy.repository | string | `"longhornio/openshift-origin-oauth-proxy"` | Repository for the OAuth Proxy image. This setting applies only to OpenShift users. |
| image.openshift.oauthProxy.tag | float | `4.14` | Tag for the OAuth Proxy image. This setting applies only to OpenShift users. Specify OCP/OKD version 4.1 or later. The latest stable version is 4.14. |
| image.openshift.oauthProxy.repository | string | `""` | Repository for the OAuth Proxy image. Specify the upstream image (for example, "quay.io/openshift/origin-oauth-proxy"). This setting applies only to OpenShift users. |
| image.openshift.oauthProxy.tag | float | `""` | Tag for the OAuth Proxy image. Specify OCP/OKD version 4.1 or later (including version 4.15, which is available at quay.io/openshift/origin-oauth-proxy:4.15). This setting applies only to OpenShift users. |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy that applies to all user-deployed Longhorn components, such as Longhorn Manager, Longhorn driver, and Longhorn UI. |

### Service Settings
Expand Down

0 comments on commit 0f532a7

Please sign in to comment.