Skip to content

Commit 0b4167c

Browse files
update docs - specify which resources require admin token
1 parent 4ed8435 commit 0b4167c

17 files changed

+30
-26
lines changed

codefresh/data_account.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99

1010
func dataSourceAccount() *schema.Resource {
1111
return &schema.Resource{
12-
Description: "This data source retrieves an account by _id or name.",
12+
Description: "This data source retrieves an account by _id or name. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.",
1313
Read: dataSourceAccountRead,
1414
Schema: map[string]*schema.Schema{
1515
"_id": {

codefresh/data_idps.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010

1111
func dataSourceIdps() *schema.Resource {
1212
return &schema.Resource{
13-
Description: "This data source retrieves all Identity Providers (IdPs) in the system.",
13+
Description: "This data source retrieves all Identity Providers (IdPs) in the system. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.",
1414
Read: dataSourceIdpRead,
1515
Schema: IdpSchema(),
1616
}

codefresh/data_user.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010

1111
func dataSourceUser() *schema.Resource {
1212
return &schema.Resource{
13-
Description: "This data source retrieves a user by email.",
13+
Description: "This data source retrieves a user by email. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.",
1414
Read: dataSourceUserRead,
1515
Schema: *UserSchema(),
1616
}

codefresh/data_users.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99

1010
func dataSourceUsers() *schema.Resource {
1111
return &schema.Resource{
12-
Description: "This data source retrieves all users in the system.",
12+
Description: "This data source retrieves all users in the system. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.",
1313
Read: dataSourceUsersRead,
1414
Schema: map[string]*schema.Schema{
1515
"users": {

codefresh/resource_account.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
func resourceAccount() *schema.Resource {
99
return &schema.Resource{
1010
Description: `
11-
By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams.
11+
By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
1212
`,
1313
Create: resourceAccountCreate,
1414
Read: resourceAccountRead,

codefresh/resource_account_admins.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
func resourceAccountAdmins() *schema.Resource {
1010
return &schema.Resource{
1111
Description: `
12-
Use this resource to set a list of admins for any account.
12+
Use this resource to set a list of admins for any account. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
1313
`,
1414
Create: resourceAccountAdminsCreate,
1515
Read: resourceAccountAdminsRead,

codefresh/resource_api_key.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ func resourceApiKey() *schema.Resource {
1414
return &schema.Resource{
1515
Description: `
1616
Manages an API Key tied to an Account and a User.
17+
Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
1718
`,
1819
Create: resourceApiKeyCreate,
1920
Read: resourceApiKeyRead,

codefresh/resource_user.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111

1212
func resourceUser() *schema.Resource {
1313
return &schema.Resource{
14-
Description: "This resource is used to manage a Codefresh user.",
14+
Description: "This resource is used to manage a Codefresh user. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.",
1515
Create: resourceUsersCreate,
1616
Read: resourceUsersRead,
1717
Update: resourceUsersUpdate,

docs/data-sources/account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
page_title: "codefresh_account Data Source - terraform-provider-codefresh"
33
subcategory: ""
44
description: |-
5-
This data source retrieves an account by _id or name.
5+
This data source retrieves an account by _id or name. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
66
---
77

88
# codefresh_account (Data Source)
99

10-
This data source retrieves an account by _id or name.
10+
This data source retrieves an account by _id or name. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
1111

1212
## Example Usage
1313

docs/data-sources/idps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: |-
77

88
# codefresh_idps (Data Source)
99

10-
This data source retrieves all Identity Providers (IdPs) in the system.
10+
This data source retrieves all Identity Providers (IdPs) in the system. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
1111

1212
## Example Usage
1313

@@ -55,7 +55,7 @@ resource "codefresh_user" "user1" {
5555
idp_id = data.codefresh_idps.idp_azure.id
5656
sso = true
5757
}
58-
58+
5959
login {
6060
idp_id = data.codefresh_idps.local.id
6161
//sso = false
@@ -99,4 +99,4 @@ resource "codefresh_idp_accounts" "acc_idp" {
9999
- `cookie_key` (String)
100100
- `id` (String) The ID of this resource.
101101
- `scopes` (Set of String)
102-
- `tenant` (String)
102+
- `tenant` (String)

0 commit comments

Comments
 (0)