-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
94 additions
and
0 deletions.
There are no files selected for viewing
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,94 @@ | ||
| # API Key resource | ||
|
|
||
| By default **terraform-provider-codefresh** uses API key, passed as provider's attribute, but it's possible to generate a new one. | ||
| Codefresh API allows to operate only with entities in the current account, which owns the provided API Key. | ||
| To be able to operate with entities in different accounts - you should create a new key in the relevant account and use providers [alias](https://www.terraform.io/docs/configuration/providers.html#alias-multiple-provider-instances). | ||
|
|
||
| ## Example usage | ||
|
|
||
| ```hcl | ||
| provider "codefresh" { | ||
| api_url = "my API URL" | ||
| token = "my init API token" | ||
| } | ||
| resource "codefresh_account" "test" { | ||
| name = "my new account" | ||
| } | ||
| resource "random_string" "random" { | ||
| length = 16 | ||
| special = false | ||
| } | ||
| resource "codefresh_api_key" "new" { | ||
| account_id = codefresh_account.test.id | ||
| name = "tfkey_${random_string.random.result}" | ||
| scopes = [ | ||
| "agent", | ||
| "agents", | ||
| "audit", | ||
| "build", | ||
| "cluster", | ||
| "clusters", | ||
| "environments-v2", | ||
| "github-action", | ||
| "helm", | ||
| "kubernetes", | ||
| "pipeline", | ||
| "project", | ||
| "repos", | ||
| "runner-installation", | ||
| "step-type", | ||
| "step-types", | ||
| "view", | ||
| "workflow", | ||
| ] | ||
| } | ||
| provider "codefresh" { | ||
| alias = "new_account" | ||
| api_url = "my API URL" | ||
| token = codefresh_api_key.new.token | ||
| } | ||
| resource "codefresh_team" "team_1" { | ||
| provider = codefresh.new_account | ||
| name = "team name" | ||
| } | ||
| ``` | ||
|
|
||
| ## Argument Reference | ||
|
|
||
| - `name` - (Required) The display name for the API key. | ||
| - `account_id` - (Required) The ID of account than should own the new API key. | ||
| - `scopes` - (Optional) A list of access scopes, that can be targeted. The possible values: | ||
| - `agent` | ||
| - `agents` | ||
| - `audit` | ||
| - `build` | ||
| - `cluster` | ||
| - `clusters` | ||
| - `environments-v2` | ||
| - `github-action` | ||
| - `helm` | ||
| - `kubernetes` | ||
| - `pipeline` | ||
| - `project` | ||
| - `repos` | ||
| - `runner-installation` | ||
| - `step-type` | ||
| - `step-types` | ||
| - `view` | ||
| - `workflow` | ||
|
|
||
| ## Attributes Reference | ||
|
|
||
| - `id` - The Key ID. | ||
| - `token` - The Token, that should used as a new provider's token attribute. | ||
|
|