Skip to content

Commit 4b95aa1

Browse files
committed
Add account doc
1 parent 9530d35 commit 4b95aa1

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

docs/resources/account.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Account resource
2+
3+
By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams.
4+
See the [documentation](https://codefresh.io/docs/docs/administration/ent-account-mng/).
5+
6+
## Example usage
7+
8+
```hcl
9+
resource "codefresh_account" "test" {
10+
name = "my_account_name"
11+
12+
13+
admins = [
14+
"5efc3cb6355c6647041b6e49",
15+
"5f0acee3b6132b460546c1c6",
16+
"59009221c102763beda7cf04"
17+
]
18+
19+
limits {
20+
collaborators = 25
21+
data_retention_weeks = 5
22+
}
23+
24+
build {
25+
parallel = 27
26+
}
27+
28+
}
29+
```
30+
31+
## Argument Reference
32+
33+
- `name` - (Required) The display name for the account.
34+
- `admins` - (Optional) A list of users IDs to set them as account admins.
35+
- `limits` - (Optional) A collection of `limits` blocks as documented below.
36+
- `build` - (Optional) A collection of `build` blocks as documented below.
37+
38+
---
39+
40+
`limits` supports the following:
41+
- `collaborators` - (Optional) Max account's collaborators number.
42+
- `data_retention_weeks` -(Optional) How long in weeks will the builds be stored.
43+
44+
---
45+
46+
`build` supports the following:
47+
- `parallel` - (Optional) How many pipelines can be run in parallel.
48+
` `node` - (Optional) Number of nodes.
49+
50+
## Attributes Reference
51+
52+
- `id` - The Account ID.
53+
54+
## Import
55+
56+
```sh
57+
terraform import codefresh_account.test xxxxxxxxxxxxxxxxxxx
58+
```

0 commit comments

Comments
 (0)