-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add armory cd and spinnaker operator install
- Loading branch information
Showing
10 changed files
with
554 additions
and
273 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
content/en/includes/plugins/github/accounts-config-example.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
In this example, you have `company-public` and `company-private` GitHub organizations, so you created two GitHub Apps, one for each org. | ||
* You installed the GitHub App for the `company-private` org with access to all repos in the org. | ||
* You installed the GitHub App for the `company-public` org with access to two specific repos in the org. | ||
|
||
Your `accounts` config looks like this: | ||
|
||
```yaml | ||
github: | ||
plugin: | ||
accounts: | ||
- name: FirstAppRepo | ||
organization: company-public | ||
repository: first-app-repo | ||
defaultBranch: master | ||
githubAppId: 9753 | ||
githubAppPrivateKey: encrypted:k8s!n:spin-secrets!k:github-company-public-token | ||
- name: SecondAppRepo | ||
organization: company-public | ||
repository: second-app-repo | ||
defaultBranch: main | ||
githubAppId: 9753 | ||
githubAppPrivateKey: encrypted:k8s!n:spin-secrets!k:github-company-public-token | ||
- name: CompanyPrivateOrgAllRepos | ||
organization: company-private | ||
orgWide: true | ||
defaultBranch: main | ||
githubAppId: 1357 | ||
githubAppPrivateKey: encrypted:k8s!n:spin-secrets!k:github-company-private-token | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
| Armory CD Version | Spinnaker Version | GitHub API Plugin Version | | ||
|:----------------- |:----------------- | :------------------------ | | ||
| 2.30.x | 1.30.x | 1.0.0 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
* You have read the GitHub API Plugin [overview]({{< ref "plugins/github-api/_index.md" >}}). | ||
* You are familiar with [GitHub Apps](https://docs.github.com/en/apps/overview). | ||
* You need to create and install a GitHub App that interacts with the GitHub API plugin. | ||
|
||
1. Create a GitHub App. Follow the instructions in GitHub's [Registering a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) guide. | ||
|
||
* Provide values for **GitHub App name**. **Homepage URL**, and **Repository permissions**. You _do not_ need to fill out the **Identifying and authorizing users**, **Post installation**, or **Webhook** sections. | ||
* Your GitHub App should have the following **Repository permissions**: | ||
|
||
* **Actions**: `Read and write` | ||
* **Contents**: `Read and write` | ||
* **Deployments**: `Read and write` | ||
* **Metadata**: `Read-only` | ||
|
||
1. Install the GitHub App you created either in a specific repo or organization-wide. Follow the instructions in GitHub's [Installing your own GitHub App](https://docs.github.com/en/apps/using-github-apps/installing-your-own-github-app) guide. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
|
||
* `version`: Replace `<version>` with the plugin version compatible with your Spinnaker version. | ||
* `accounts`: Configure the GitHub location(s) where you installed the GitHub App you created. The configuration differs depending on whether you installed the GitHub App organization-wide or with access to individual repositories. | ||
|
||
{{< tabpane text=true right=true >}} | ||
{{% tab header="**Account Config**:" disabled=true /%}} | ||
{{% tab header="Individual Repo" %}} | ||
|
||
```yaml | ||
- name: <name> | ||
organization: <github_organization> | ||
repository: <github_repository> | ||
defaultBranch: <default_github_branch> | ||
githubAppId: <github_app_id> | ||
githubAppPrivateKey: <your_github_private_key> | ||
``` | ||
All fields are required. | ||
* `name`: Unique name; this name appears in the GitHub API stages' `GitHub Account` select list. | ||
* `organization`: GitHub organization that you installed the GitHub App in | ||
* `repository`: The GitHub repository to access | ||
* `defaultBranch`: Default repository branch; for example, main or master | ||
* `githubAppId`: The GitHub App's **App ID** | ||
* `githubAppPrivateKey`: The GitHub App's private key; this field supports encrypted field references; see [Work with Secrets in Spinnaker]({{< ref "continuous-deployment/armory-admin/secrets" >}}) for details. | ||
|
||
{{% /tab %}} | ||
{{% tab header="All Repos in Org" %}} | ||
|
||
```yaml | ||
- name: <name> | ||
organization: <github_organization> | ||
orgWide: true | ||
defaultBranch: <default_github_branch> | ||
githubAppId: <github_app_id> | ||
githubAppPrivateKey: <your_github_private_key> | ||
``` | ||
|
||
All fields are required. | ||
|
||
* `name`: Unique name; this name appears in the GitHub API stages' `GitHub Account` select list. | ||
* `organization`: GitHub organization that you installed the GitHub App in | ||
* `orgWide`: `true` | ||
* `defaultBranch`: Default repository branch; for example, main or master | ||
* `githubAppId`: The GitHub App's **App ID** | ||
* `githubAppPrivateKey`: The GitHub App's private key; this field supports encrypted field references; see [Work with Secrets in Spinnaker]({{< ref "continuous-deployment/armory-admin/secrets" >}}) for details. | ||
|
||
{{% /tab %}} | ||
{{< /tabpane >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.