Skip to content

Commit

Permalink
docs(chore): replace old tabs shortcode with Docsy version (#89)
Browse files Browse the repository at this point in the history
  • Loading branch information
aimeeu authored Oct 31, 2023
1 parent f370fe9 commit 861ae83
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 122 deletions.
18 changes: 0 additions & 18 deletions content/en/includes/include-tabs.md

This file was deleted.

59 changes: 32 additions & 27 deletions content/en/integrations/plugin-spinnaker/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,16 @@ The Helm chart described in [Enable the Armory CD-as-a-Service Remote Network Ag

## Register your environment

{{< tabs name="RegisterEnv" >}}
{{% tabbody name="Armory CD" %}}
{{< tabpane text=true right=true >}}
{{% tab header="**Environment**:" disabled=true /%}}
{{% tab header="Armory CD" %}}

Register your Armory CD environment so that it can communicate with Armory services. Each environment needs to get registered if you, for example, have production and development environments.

Register your Armory CD [environment](https://docs.armory.io/continuous-deployment/installation/ae-instance-reg/).

{{% /tabbody %}}
{{% tabbody name="Spinnaker" %}}
{{% /tab %}}
{{% tab header="Spinnaker" %}}

[Create a new CD-as-a-Service credential]({{< ref "/iam/manage-client-creds" >}}) for your Spinnaker instance so it can authenticate with CD-as-a-Service.

Expand All @@ -68,8 +69,8 @@ In the CD-as-a-Service Console, go to the **Access Management** > **Client Crede

Click **Create Credential**. Copy the **Client ID** and **Client Secret** values for use in the _[Install the plugin](#install-the-plugin)_ section.

{{% /tabbody %}}
{{< /tabs >}}
{{% /tab %}}
{{< /tabpane >}}

## Install the CD-as-a-Service Remote Network Agent

Expand Down Expand Up @@ -104,8 +105,9 @@ time="2021-07-16T17:48:30Z" level=info msg="starting agentCreator provider:\"kub

>You can configure Spinnaker secrets as outlined in the [Work with Secrets in Spinnaker](https://docs.armory.io/continuous-deployment/armory-admin/secrets) guide. This means you can set the Client Secret value a secret token instead of the plain text value.
{{< tabs name="DeploymentPlugin" >}}
{{% tabbody name="Operator" %}}
{{< tabpane text=true right=true >}}
{{% tab header="**Method**:" disabled=true /%}}
{{% tab header="Operator" %}}

If you are running Armory CD 2.26.3, `armory.cloud` block goes in a different location. Instead of `spec.spinnakerConfig.spinnaker`, the block needs to go under both `spec.spinnakerConfig.gate` and `spec.spinnakerConfig.orca`. For more information see [Known issues](#known-issues). Additionally there is a `plugins` block that needs to be added.

Expand Down Expand Up @@ -173,8 +175,8 @@ Apply the changes to your Armory CD instance.
kubectl apply -k <path-to-kustomize-file>.yml
```

{{% /tabbody %}}
{{% tabbody name="Halyard" %}}
{{% /tab %}}
{{% tab header="Halyard" %}}

If you are running Armory CD 2.26.3, `armory.cloud` block needs to go in `gate-local.yml` and `orca-local.yml` instead of `spinnaker-local.yml`. For more information see [Known issues](#known-issues). Other than the change in location, the installation instructions remain the same.

Expand Down Expand Up @@ -226,8 +228,8 @@ Apply the changes to your Armory CD instance.
hal deploy apply
```

{{% /tabbody %}}
{{< /tabs >}}
{{% /tab %}}
{{< /tabpane >}}

### Verify that the plugin is configured

Expand Down Expand Up @@ -275,20 +277,21 @@ You have the following options for adding your Armory CD-as-a-Service deployment

#### Configure the stage

The **Deployment Configuration** section is where you define your Armory CD-as-a-Service progressive deployment and consists of the following parts:
The **Deployment Configuration** section is where you define your Armory CD-as-a-Service progressive deployment and consists of [manifest source](#manifest-source) and [required artifacts to bind](#required-artifacts-to-bind).

**Manifest Source**
##### Manifest source

{{< tabs name="DeploymentYAMLManifestSource" >}}
{{% tabbody name="Text" %}}
{{< tabpane text=true right=true >}}
{{% tab header="**Manifest Source**:" disabled=true /%}}
{{% tab header="Text" %}}

1. Choose **Text** for the **Manifest Source**.
1. Paste your deployment file YAML into the **Deployment YAML** text box. For example:

{{< figure src="prog-deploy-yaml.png" alt="Example of a deployment YAML file pasted into the Deployment YAML text box." >}}

{{% /tabbody %}}
{{% tabbody name="Artifact" %}}
{{% /tab %}}
{{% tab header="Artifact" %}}

Before you select **Artifact**, make sure you have added your Armory CD-as-a-Service deployment file as a pipeline artifact.

Expand All @@ -297,11 +300,12 @@ Before you select **Artifact**, make sure you have added your Armory CD-as-a-Ser

{{< figure src="prog-deploy-artifact.png" alt="Example of a deployment YAML file attached as an artifact." >}}

{{% /tabbody %}}
{{< /tabs >}}
{{% /tab %}}
{{< /tabpane >}}
<br>
<br>
**Required Artifacts to Bind**

##### Required artifacts to bind

For each manifest you list in the `manifests.path` section of your Armory CD-as-a-Service deployment file, you must bind the artifact to the stage.

Expand Down Expand Up @@ -419,8 +423,9 @@ Armory CD-as-a-Service has the following constraints when deploying a manifest:

In Armory CD 2.26.3, the location of where you put the `armory.cloud` config block is different from other versions. Additionally, there is an additional config block for `spec.spinnakerConfig.profiles.gate.spinnaker.extensibility` that contains information for the plugin named `plugins`.

{{< tabs name="KnownIssue" >}}
{{% tabbody name="Operator" %}}
{{< tabpane text=true right=true >}}
{{% tab header="**Method**:" disabled=true /%}}
{{% tab header="Operator" %}}

Your Kustomize patch file should resemble the following where `armory.cloud` is a child of the `gate` and `orca` blocks instead of a `spinnaker` block:

Expand Down Expand Up @@ -484,8 +489,8 @@ spec:



{{% /tabbody %}}
{{% tabbody name="Halyard" %}}
{{% /tab %}}
{{% tab header="Halyard" %}}

Your `spinnaker-local.yml` file should not have the `armory.cloud` block anymore and only contain the block to install the plugin:

Expand Down Expand Up @@ -547,8 +552,8 @@ armory.cloud:
baseUrl: https://api.cloud.armory.io
```

{{% /tabbody %}}
{{< /tabs >}}
{{% /tab %}}
{{< /tabpane >}}

> This product documentation page is Armory confidential information.

Expand Down
13 changes: 7 additions & 6 deletions content/en/troubleshooting/rbac/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ tags: ["RBAC"]

**Why this happens**
<br>
{{< tabs name="no-role" >}}
{{% tabbody name="No SSO" %}}

{{< tabpane text=true right=true >}}
{{% tab header="No SSO" %}}
The user doesn't have an RBAC role. This happens when:

* The Organization Admin didn't create any RBAC roles.
Expand All @@ -29,8 +30,8 @@ Organization Admin is a system role. CD-as-a-Service automatically assigns that
* Assign the existing Organization Admin role to the affected user.
* [Create at least one custom RBAC role]({{< ref "iam/manage-rbac-roles.md" >}}) and then assign that RBAC role to the affected user.

{{% /tabbody %}}
{{% tabbody name="SSO" %}}
{{% /tab %}}
{{% tab header="SSO" %}}

* The user doesn't have the correct SSO groups assigned in your company's SSO provider.
* The Organization or Tenant Admin didn't create an RBAC role that corresponds to the SSO group. The CD-as-a-Service RBAC role name must be identical to the SSO group name.
Expand All @@ -40,7 +41,7 @@ Organization Admin is a system role. CD-as-a-Service automatically assigns that
* [Create RBAC roles]({{< ref "iam/manage-rbac-roles#sso-roles" >}}) to match the SSO groups that you want to use with CD-as-a-Service.


{{% /tabbody %}}
{{< /tabs >}}
{{% /tab %}}
{{< /tabpane >}}


20 changes: 0 additions & 20 deletions layouts/shortcodes/tabbody.html

This file was deleted.

51 changes: 0 additions & 51 deletions layouts/shortcodes/tabs.html

This file was deleted.

0 comments on commit 861ae83

Please sign in to comment.