Skip to content

Commit

Permalink
Replace misleading placeholder for helm command examples (Closes #993)
Browse files Browse the repository at this point in the history
  • Loading branch information
Markus Napp committed Sep 17, 2020
1 parent aeae6a8 commit 1a888af
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
10 changes: 5 additions & 5 deletions adoc/admin-logging-centralized.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@ See <<log-optional_settings>> for the optional parameters and their default valu
[source,bash]
----
helm repo add suse https://kubernetes-charts.suse.com
helm install suse/log-agent-rsyslog --name ${RELEASE_NAME} --namespace kube-system --set server.host=${SERVER_HOST} --set server.port=${SERVER_PORT}
helm install suse/log-agent-rsyslog --name <RELEASE_NAME> --namespace kube-system --set server.host=${SERVER_HOST} --set server.port=${SERVER_PORT}
----
Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
[source,bash]
----
helm repo add suse https://kubernetes-charts.suse.com
helm install ${RELEASE_NAME} suse/log-agent-rsyslog --namespace kube-system --set server.host=${SERVER_HOST} --set server.port=${SERVER_PORT}
helm install <RELEASE_NAME> suse/log-agent-rsyslog --namespace kube-system --set server.host=${SERVER_HOST} --set server.port=${SERVER_PORT}
----

[NOTE]
Expand All @@ -113,16 +113,16 @@ After this step, all of the log agents will initialize then start to forward log

- To check the installation progress, use the `helm status` command:
----
helm status ${RELEASE_NAME}
helm status <RELEASE_NAME>
----

- To uninstall log agents, use the `helm delete` command:
----
helm delete --purge ${RELEASE_NAME}
helm delete --purge <RELEASE_NAME>
----
Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
----
helm uninstall ${RELEASE_NAME}
helm uninstall <RELEASE_NAME>
----

== Queuing
Expand Down
24 changes: 12 additions & 12 deletions adoc/admin-security-certificates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,13 @@ We use cert-exporter to monitor nodes' on-host certificates and addons' secret c
[source,bash]
----
helm repo add suse https://kubernetes-charts.suse.com
helm install suse/cert-exporter --name ${RELEASE_NAME}
helm install suse/cert-exporter --name <RELEASE_NAME>
----
Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
[source,bash]
----
helm repo add suse https://kubernetes-charts.suse.com
helm install ${RELEASE_NAME} suse/cert-exporter
helm install <RELEASE_NAME> suse/cert-exporter
----

=== Prerequisites
Expand Down Expand Up @@ -202,7 +202,7 @@ For example:
[source,bash]
----
helm install suse/cert-exporter \
--name ${RELEASE_NAME} \
--name <RELEASE_NAME> \
--set customSecret.enabled=true \
--set customSecret.certs[0].name=cert-manager \
--set customSecret.certs[0].namespace=cert-manager-test \
Expand All @@ -213,7 +213,7 @@ Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
+
[source,bash]
----
helm install ${RELEASE_NAME} suse/cert-exporter \
helm install <RELEASE_NAME> suse/cert-exporter \
--set customSecret.enabled=true \
--set customSecret.certs[0].name=cert-manager \
--set customSecret.certs[0].namespace=cert-manager-test \
Expand All @@ -226,7 +226,7 @@ helm install ${RELEASE_NAME} suse/cert-exporter \
[source,bash]
----
helm install suse/cert-exporter \
--name ${RELEASE_NAME} \
--name <RELEASE_NAME> \
--set customSecret.enabled=true \
--set customSecret.certs[0].name=self-signed-cert \
--set customSecret.certs[0].includeKeys="{ca.crt,tls.crt}" \
Expand All @@ -236,7 +236,7 @@ Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
+
[source,bash]
----
helm install ${RELEASE_NAME} suse/cert-exporter \
helm install <RELEASE_NAME> suse/cert-exporter \
--set customSecret.enabled=true \
--set customSecret.certs[0].name=self-signed-cert \
--set customSecret.certs[0].includeKeys="{ca.crt,tls.crt}" \
Expand All @@ -248,7 +248,7 @@ helm install ${RELEASE_NAME} suse/cert-exporter \
[source,bash]
----
helm install suse/cert-exporter \
--name ${RELEASE_NAME} \
--name <RELEASE_NAME> \
--set customSecret.enabled=true \
--set customSecret.certs[0].name=cert-manager \
--set customSecret.certs[0].namespace=cert-manager-test \
Expand All @@ -262,7 +262,7 @@ Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
+
[source,bash]
----
helm install ${RELEASE_NAME} suse/cert-exporter \
helm install <RELEASE_NAME> suse/cert-exporter \
--set customSecret.enabled=true \
--set customSecret.certs[0].name=cert-manager \
--set customSecret.certs[0].namespace=cert-manager-test \
Expand All @@ -278,7 +278,7 @@ helm install ${RELEASE_NAME} suse/cert-exporter \
[source,bash]
----
helm install suse/cert-exporter \
--name ${RELEASE_NAME} \
--name <RELEASE_NAME> \
--set node.enabled=false \
--set addon.enabled=false \
--set customSecret.enabled=true \
Expand All @@ -294,7 +294,7 @@ Or if you have selected the Helm 3 alternative also see <<helm-tiller-install>>:
+
[source,bash]
----
helm install ${RELEASE_NAME} suse/cert-exporter \
helm install <RELEASE_NAME> suse/cert-exporter \
--set node.enabled=false \
--set addon.enabled=false \
--set customSecret.enabled=true \
Expand Down Expand Up @@ -620,7 +620,7 @@ kubectl create secret tls custom-trusted-ca --cert=<CUSTOM_TRUSTED_CA_CERT> --ke
[source,bash]
----
helm install suse/reloader \
--name ${RELEASE_NAME} \
--name <RELEASE_NAME> \
--namespace cert-manager
----

Expand All @@ -629,7 +629,7 @@ helm install suse/reloader \
[source,bash]
----
helm install suse/cert-manager \
--name ${RELEASE_NAME} \
--name <RELEASE_NAME> \
--namespace cert-manager \
--set global.leaderElection.namespace=cert-manager \
--set installCRDs=true
Expand Down

0 comments on commit 1a888af

Please sign in to comment.