update docs - specify which resources require admin token

codefresh-io · Jul 10, 2024 · 0b4167c · 0b4167c
1 parent 4ed8435
commit 0b4167c
Show file tree

Hide file tree

Showing 17 changed files with 30 additions and 26 deletions.
diff --git a/codefresh/data_account.go b/codefresh/data_account.go
@@ -9,7 +9,7 @@ import (
 
 func dataSourceAccount() *schema.Resource {
 	return &schema.Resource{
-		Description: "This data source retrieves an account by _id or name.",
+		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.",
 		Read:        dataSourceAccountRead,
 		Schema: map[string]*schema.Schema{
 			"_id": {

diff --git a/codefresh/data_idps.go b/codefresh/data_idps.go
@@ -10,7 +10,7 @@ import (
 
 func dataSourceIdps() *schema.Resource {
 	return &schema.Resource{
-		Description: "This data source retrieves all Identity Providers (IdPs) in the system.",
+		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.",
 		Read:        dataSourceIdpRead,
 		Schema:      IdpSchema(),
 	}

diff --git a/codefresh/data_user.go b/codefresh/data_user.go
@@ -10,7 +10,7 @@ import (
 
 func dataSourceUser() *schema.Resource {
 	return &schema.Resource{
-		Description: "This data source retrieves a user by email.",
+		Description: "This data source retrieves a user by email. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.",
 		Read:        dataSourceUserRead,
 		Schema:      *UserSchema(),
 	}

diff --git a/codefresh/data_users.go b/codefresh/data_users.go
@@ -9,7 +9,7 @@ import (
 
 func dataSourceUsers() *schema.Resource {
 	return &schema.Resource{
-		Description: "This data source retrieves all users in the system.",
+		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.",
 		Read:        dataSourceUsersRead,
 		Schema: map[string]*schema.Schema{
 			"users": {

diff --git a/codefresh/resource_account.go b/codefresh/resource_account.go
@@ -8,7 +8,7 @@ import (
 func resourceAccount() *schema.Resource {
 	return &schema.Resource{
 		Description: `
-		By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams.
+		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.
 		`,
 		Create: resourceAccountCreate,
 		Read:   resourceAccountRead,

diff --git a/codefresh/resource_account_admins.go b/codefresh/resource_account_admins.go
@@ -9,7 +9,7 @@ import (
 func resourceAccountAdmins() *schema.Resource {
 	return &schema.Resource{
 		Description: `
-		Use this resource to set a list of admins for any account.
+		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.
 		`,
 		Create: resourceAccountAdminsCreate,
 		Read:   resourceAccountAdminsRead,

diff --git a/codefresh/resource_api_key.go b/codefresh/resource_api_key.go
@@ -14,6 +14,7 @@ func resourceApiKey() *schema.Resource {
 	return &schema.Resource{
 		Description: `
 		Manages an API Key tied to an Account and a User.
+		Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 		`,
 		Create: resourceApiKeyCreate,
 		Read:   resourceApiKeyRead,

diff --git a/codefresh/resource_user.go b/codefresh/resource_user.go
@@ -11,7 +11,7 @@ import (
 
 func resourceUser() *schema.Resource {
 	return &schema.Resource{
-		Description: "This resource is used to manage a Codefresh user.",
+		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.",
 		Create:      resourceUsersCreate,
 		Read:        resourceUsersRead,
 		Update:      resourceUsersUpdate,

diff --git a/docs/data-sources/account.md b/docs/data-sources/account.md
@@ -2,12 +2,12 @@
 page_title: "codefresh_account Data Source - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  This data source retrieves an account by _id or name.
+  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.
 ---
 
 # codefresh_account (Data Source)
 
-This data source retrieves an account by _id or name.
+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.
 
 ## Example Usage
 

diff --git a/docs/data-sources/idps.md b/docs/data-sources/idps.md
@@ -7,7 +7,7 @@ description: |-
 
 # codefresh_idps (Data Source)
 
-This data source retrieves all Identity Providers (IdPs) in the system.
+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.
 
 ## Example Usage
 
@@ -55,7 +55,7 @@ resource "codefresh_user" "user1" {
       idp_id = data.codefresh_idps.idp_azure.id
       sso = true
   }
-
+  
   login  {
       idp_id = data.codefresh_idps.local.id
       //sso = false
@@ -99,4 +99,4 @@ resource "codefresh_idp_accounts" "acc_idp" {
 - `cookie_key` (String)
 - `id` (String) The ID of this resource.
 - `scopes` (Set of String)
-- `tenant` (String)
+- `tenant` (String)
diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md
@@ -2,7 +2,7 @@
 page_title: "codefresh_user Data Source - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  This data source retrieves a user by email.
+  This data source retrieves a user by email. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_user (Data Source)
@@ -88,4 +88,4 @@ Read-Only:
 
 Read-Only:
 
-- `user_name` (String)
+- `user_name` (String)
diff --git a/docs/data-sources/users.md b/docs/data-sources/users.md
@@ -2,7 +2,7 @@
 page_title: "codefresh_users Data Source - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  This data source retrieves all users in the system.
+  This data source retrieves all users in the system. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_users (Data Source)
@@ -81,4 +81,4 @@ Read-Only:
 
 Read-Only:
 
-- `user_name` (String)
+- `user_name` (String)
diff --git a/docs/resources/account.md b/docs/resources/account.md
@@ -7,7 +7,7 @@ description: |-
 
 # codefresh_account (Resource)
 
-By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams.
+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.
 
 See the [documentation](https://codefresh.io/docs/docs/administration/account-user-management/).
 
@@ -86,4 +86,4 @@ Optional:
 ## Import
 ```sh
 terraform import codefresh_account.test xxxxxxxxxxxxxxxxxxx
-```
+```
diff --git a/docs/resources/account_admins.md b/docs/resources/account_admins.md
@@ -7,7 +7,7 @@ description: |-
 
 # codefresh_account_admins (Resource)
 
-Use this resource to set a list of admins for any account.
+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.
 
 ## Example usage
 
@@ -72,4 +72,4 @@ resource "codefresh_account_admins" "test" {
 
 ```sh
 terraform import codefresh_account_admins.test xxxxxxxxxxxxxxxxxxx
-```
+```
diff --git a/docs/resources/account_gitops_settings.md b/docs/resources/account_gitops_settings.md
@@ -41,7 +41,7 @@ resource "codefresh_account_gitops_settings" "gitops-settings" {
 - `id` (String) Account Id
 - `name` (String) Account name for active account
 
-~>
+[!WARNING]
 Once internal config repository is cloned successfully by one or more runtimes it can no longer be changed and all attempted updates will fail.
 If you need to change the repository please contact Codefresh support.
 

diff --git a/docs/resources/api_key.md b/docs/resources/api_key.md
@@ -2,14 +2,16 @@
 page_title: "codefresh_api_key Resource - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  Manages an API Key tied to an Account and a User. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
+  Manages an API Key tied to an Account and a User.
+      Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_api_key (Resource)
 
 Manages an API Key tied to an Account and a User.
+		Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 
-terraform-provider-codefresh itself uses an API key, passed as provider's attribute, but it's possible to use that API Key to generate a new one.
+terraform-provider-codefresh itself uses an API key, passed as provider's attribute, but it's possible to use that API Key to generate a new one. 
 This resource requires Codefresh system admin permissions, hence is relevant for on-prem deployments of Codefresh only.
 
 
@@ -106,4 +108,4 @@ resource "codefresh_team" "team_1" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `token` (String, Sensitive) The resulting API key.
+- `token` (String, Sensitive) The resulting API key.
diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -7,7 +7,7 @@ description: |-
 
 # codefresh_user (Resource)
 
-This resource is used to manage a Codefresh user.
+This resource is used to manage a Codefresh user. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 
 
 
@@ -43,7 +43,7 @@ resource "codefresh_user" "new" {
       idp_id = data.codefresh_idps.idp_azure.id
       sso = true
   }
-
+  
   login  {
       idp_id = data.codefresh_idps.local.id
       //sso = false
@@ -119,3 +119,4 @@ Read-Only:
 ```sh
 terraform import codefresh_user.new xxxxxxxxxxxxxxxxxxx
 ```
+