Use the Custom Tabs Shortcode

Examples of how to use the custom Tabs shortcode.

Tabs - Docsy shortcode

Introduced in 2022. https://www.docsy.dev/docs/adding-content/shortcodes/#tabbed-panes

Tabbed panes with included files - do not use the Docsy readfile shortcode inside the Docsy tabbed pane shortcode! Markdown and HTML do not render correctly.

Examples of including markdown files using the armory/docs include shortcode. Note the delimiters!

tab with %, include with %


{{< tabpane text=true right=true >}}
  {{< tab header="**Mode**:" disabled=true />}}
  {{% tab header="Cluster" text=true %}}
  {{% include "armory-operator/op-install-cluster.md" %}}
  {{% /tab %}}
  {{% tab header="Basic" text=true %}}
  {{% include  "armory-operator/op-install-basic.md" %}}
  {{% /tab %}}
{{< /tabpane >}}

RENDERED OUTPUT

You need Kubernetes ClusterRole authority to install the Operator in cluster mode. You should use Cluster mode to do one of the following:

Install a single Spinnaker Operator to manage an entire Kubernetes cluster of Spinnaker installations
Install a single Armory Operator to manage an entire Kubernetes cluster of Armory CD installations

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/cluster after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation

 <figure>
     <img src="/images/proprietary.svg"/> 
 </figure>


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In cluster mode, if you want to use a namespace other than spinnaker-operator, you need to edit the namespace in deploy/operator/cluster/role_binding.yaml.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/cluster

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

Operator in basic mode has permissions scoped to a single namespace, so the Operator can’t see anything in other namespaces. You must deploy Armory Continuous Deployment or open source Spinnaker to the same namespace as the Operator, in a 1:1 correlation (one Armory Operator per Armory CD; one Spinnaker Operator per open source Spinnaker install).

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/basic after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation Proprietary


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In basic mode, the namespace must be spinnaker-operator.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/basic

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

tab with %, include with <


{{< tabpane text=true right=true >}}
  {{< tab header="**Mode**:" disabled=true />}}
  {{% tab header="Cluster" text=true %}}
  {{< include "armory-operator/op-install-cluster.md" >}}
  {{% /tab %}}
  {{% tab header="Basic" text=true %}}
  {{< include "armory-operator/op-install-basic.md" >}}
  {{% /tab %}}
{{< /tabpane >}}

RENDERED OUTPUT

You need Kubernetes ClusterRole authority to install the Operator in cluster mode. You should use Cluster mode to do one of the following:

Install a single Spinnaker Operator to manage an entire Kubernetes cluster of Spinnaker installations
Install a single Armory Operator to manage an entire Kubernetes cluster of Armory CD installations

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/cluster after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation

 <figure>
     <img src="/images/proprietary.svg"/> 
 </figure>


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In cluster mode, if you want to use a namespace other than spinnaker-operator, you need to edit the namespace in deploy/operator/cluster/role_binding.yaml.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/cluster

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/basic after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation Proprietary


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In basic mode, the namespace must be spinnaker-operator.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/basic

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

tab with %, readfile with %


{{< tabpane text=true right=true >}}
  {{< tab header="**Mode**:" disabled=true />}}
  {{% tab header="Cluster" text=true %}}
  {{% readfile file="/includes/armory-operator/op-install-cluster.md" %}}
  {{% /tab %}}
  {{% tab header="Basic" text=true %}}
  {{% readfile file="/includes/armory-operator/op-install-basic.md" %}}
  {{% /tab %}}
{{< /tabpane >}}

RENDERED OUTPUT

<!-- this file does not contain H2 etc headings

Hugo does not render headings in included files –>

You need Kubernetes ClusterRole authority to install the Operator in cluster mode. You should use Cluster mode to do one of the following:

Install a single Spinnaker Operator to manage an entire Kubernetes cluster of Spinnaker installations
Install a single Armory Operator to manage an entire Kubernetes cluster of Armory CD installations

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/cluster after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation

 <figure>
     <img src="/images/proprietary.svg"/> 
 </figure>


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In cluster mode, if you want to use a namespace other than spinnaker-operator, you need to edit the namespace in deploy/operator/cluster/role_binding.yaml.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/cluster

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

<!-- this file does not contain H2 etc headings

Hugo does not render headings in included files –>

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/basic after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation Proprietary


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In basic mode, the namespace must be spinnaker-operator.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/basic

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

tab with %, readfile with <


{{< tabpane text=true right=true >}}
  {{< tab header="**Mode**:" disabled=true />}}
  {{% tab header="Cluster" text=true %}}
  {{< readfile file="/includes/plugins/scale-agent/api-overview.md" >}}
  {{% /tab %}}
  {{% tab header="Basic" text=true %}}
  {{< readfile file="/includes/armory-operator/op-install-basic.md" >}}
  {{% /tab %}}
{{< /tabpane >}}

RENDERED OUTPUT

<p>The Dynamic Accounts REST API provides endpoints to create, delete, get, migrate, and update Kubernetes accounts. You can&rsquo;t access these endpoints through Gate. You should have <code>kubectl</code> access to your Spinnaker cluster and <code>port-forward</code> to be able to call the API.</p>


kubectl port-forward deployment/spin-clouddriver 7002:7002 -n spinnaker

You can then access endpoints via http://localhost:7002.

<!-- this file does not contain H2 etc headings

Hugo does not render headings in included files –>

You can find the Operator’s deployment configuration in spinnaker-operator/deploy/operator/basic after you download and unpack the archive. You don’t need to update any configuration values.

Get the latest Operator release:

Armory Operator for Armory CD Installation Proprietary


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory-io/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Spinnaker Operator for Open Source Spinnaker Installation


mkdir -p spinnaker-operator && cd spinnaker-operator
  bash -c 'curl -L https://github.com/armory/spinnaker-operator/releases/latest/download/manifests.tgz | tar -xz'

Install or update CRDs across the cluster:
```
kubectl apply -f deploy/crds/
  
```
Create the namespace for the Operator:
In basic mode, the namespace must be spinnaker-operator.
```
kubectl create ns spinnaker-operator
  
```

Install the Operator:


kubectl -n spinnaker-operator apply -f deploy/operator/basic

Verify that the Operator is running:


kubectl -n spinnaker-operator get pods

The command returns output similar to the following if the pod for the Operator is running:


NAMESPACE                             READY         STATUS       RESTARTS      AGE
  spinnaker-operator-7cd659654b-4vktl   2/2           Running      0             6s

Inserting raw HTML

rawhtml

Usage:


## Heading
{{< rawhtml >}}
<p>
    This is <strong>raw HTML</strong>, inside Markdown.
  </p>
{{< /rawhtml >}}

This is raw HTML, inside Markdown.

Feedback

Was this page helpful?

Thank you for letting us know!

Sorry to hear that. Please tell us how we can improve.

Last modified September 5, 2023: (17d76bcd)