Skip to content

Commit

Permalink
Merge pull request #89 from jhkrug/1.5.5
Browse files Browse the repository at this point in the history
Fix some code block lacking subs=+attributes so {current-version} was…
  • Loading branch information
jhkrug authored Sep 6, 2024
2 parents b75236e + fb01942 commit 77c8fc0
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 0 deletions.
3 changes: 3 additions & 0 deletions modules/en/pages/deploy/install/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ IMPORTANT: On SUSE and openSUSE, the `iscsi_tcp` module is included only in the

We also provide an `iscsi` installer to make it easier for users to install `open-iscsi` automatically:

[subs="+attributes",shell]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/prerequisite/longhorn-iscsi-installation.yaml
----
Expand Down Expand Up @@ -244,12 +245,14 @@ zypper install nfs-client

We also provide an `nfs` installer to make it easier for users to install `nfs-client` automatically:

[subs="+attributes", console]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/prerequisite/longhorn-nfs-installation.yaml
----

After the deployment, run the following command to check pods' status of the installer:

[subs="+attributes", console]
----
kubectl get pod | grep longhorn-nfs-installation
NAME READY STATUS RESTARTS AGE
Expand Down
1 change: 1 addition & 0 deletions modules/en/pages/deploy/install/install-with-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ In this section, you will learn how to install Longhorn with Helm.
* Kubernetes cluster: Ensure that each node fulfills the xref:#_installation_requirements[installation requirements].
* Your workstation: Install https://helm.sh/docs/[Helm] v3.0 or later.

[subs="+attributes", console]
____
https://github.com/longhorn/longhorn/blob/v{current-version}/scripts/environment_check.sh[This script] can be used to check the Longhorn environment for potential issues.
____
Expand Down
3 changes: 3 additions & 0 deletions modules/en/pages/deploy/uninstall/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ helm uninstall longhorn -n longhorn-system

. Create the uninstallation job to clean up CRDs from the system and wait for success:
+
[subs="+attributes", console]
----
kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/uninstall/uninstall.yaml
kubectl get job/longhorn-uninstall -n longhorn-system -w
----
+
Example output:
+
[subs="+attributes", console]
----
$ kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/uninstall/uninstall.yaml
serviceaccount/longhorn-uninstall-service-account created
Expand All @@ -58,6 +60,7 @@ Example output:

. Remove remaining components:
+
[subs="+attributes", console]
----
kubectl delete -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/longhorn.yaml
kubectl delete -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/uninstall/uninstall.yaml
Expand Down
3 changes: 3 additions & 0 deletions modules/en/pages/deploy/upgrade/longhorn-manager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ image::screenshots/install/cluster-explorer.png[Image]

To upgrade with kubectl, run this command:

[subs="+attributes", console]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/longhorn.yaml
----
Expand All @@ -57,6 +58,7 @@ kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-v

To upgrade with Helm, run this command:

[subs="+attributes", console]
----
helm upgrade longhorn longhorn/longhorn --namespace longhorn-system --version {current-version}
----
Expand Down Expand Up @@ -144,6 +146,7 @@ To recover, you need to upgrade to the previously installed revision at `Rancher

* To clean up the deprecated StorageClass, run this command:
+
[subs="+attributes", console]
----
kubectl delete -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/examples/storageclass.yaml
----
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ Longhorn provides sample backupstore server setups for testing purposes. You ca

. Set up a MinIO S3 server for the backupstore in the `longhorn-system` namespace.
+
[subs="+attributes", console]
----
kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/backupstores/minio-backupstore.yaml
----
Expand Down
5 changes: 5 additions & 0 deletions modules/en/pages/v2-data-engine/quick-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ apt install -y linux-modules-extra-`uname -r`

We provide a manifest that helps you configure the kernel modules and huge pages automatically, making it easier to set up.

[subs="+attributes", console]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/prerequisite/longhorn-spdk-setup.yaml
----
Expand Down Expand Up @@ -87,6 +88,7 @@ echo "vm.nr_hugepages=512" >> /etc/sysctl.conf

We provide a manifest that helps you finish the deployment on each Longhorn node.

[subs="+attributes", console]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/deploy/prerequisite/longhorn-nvme-cli-installation.yaml
----
Expand Down Expand Up @@ -115,6 +117,7 @@ After finishing the above steps, restart kubelet on each node.

Make sure everything is correctly configured and installed by

[subs="+attributes", console]
----
bash -c "$(curl -sfL https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/scripts/environment_check.sh)" -s -s
----
Expand Down Expand Up @@ -238,6 +241,7 @@ After the installation and configuration, we can dynamically provision a Persist

Use following command to create a StorageClass called `longhorn-spdk`. Set `parameters.backendStoreDriver` to `v2` to utilize V2 Data Engine.

[subs="+attributes", console]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/examples/v2/storageclass.yaml
----
Expand All @@ -246,6 +250,7 @@ kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-v

Create a Pod that uses Longhorn volumes using V2 Data Engine by running this command:

[subs="+attributes", console]
----
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/examples/v2/pod_with_pvc.yaml
----
Expand Down
2 changes: 2 additions & 0 deletions modules/en/pages/volumes-and-nodes/create-volumes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ When the Pod is deployed, the Kubernetes master will check the PersistentVolumeC

. Use following command to create a StorageClass called `longhorn`:
+
[subs="+attributes", console]
----
kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/examples/storageclass.yaml
----
Expand Down Expand Up @@ -55,6 +56,7 @@ In particular, starting with v1.4.0, the parameter `mkfsParams` can be used to s

. Create a Pod that uses Longhorn volumes by running this command:
+
[subs="+attributes", console]
----
kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/v{current-version}/examples/pod_with_pvc.yaml
----
Expand Down

0 comments on commit 77c8fc0

Please sign in to comment.