patch - update docs: specify which resources require admin token

codefresh/cfclient/user.go

@@ -228,7 +228,9 @@ func (client *Client) GetAllUsers() (*[]User, error) {
 	var allUsers []User
 
 	for !bIsDone {
-		var userPaginatedResp struct{Docs []User `json:"docs"`}
+		var userPaginatedResp struct {
+			Docs []User `json:"docs"`
+		}
 
 		opts := RequestOptions{
 			Path:   fmt.Sprintf("/admin/user?limit=%d&page=%d", limitPerQuery, nPageIndex),
@@ -248,7 +250,7 @@ func (client *Client) GetAllUsers() (*[]User, error) {
 		}
 
 		if len(userPaginatedResp.Docs) > 0 {
-			allUsers = append(allUsers,userPaginatedResp.Docs...)
+			allUsers = append(allUsers, userPaginatedResp.Docs...)
 			nPageIndex++
 		} else {
 			bIsDone = true

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": {

codefresh/data_account_gitops_settings.go

@@ -13,28 +13,28 @@ func dataSourceAccountGitopsSettings() *schema.Resource {
 		Read:        dataSourceAccountGitopsSettingsRead,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Type:     schema.TypeString,
+				Type:        schema.TypeString,
 				Description: "Account Id",
-				Computed: true,
+				Computed:    true,
 			},
 			"name": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Account name for active account",
 			},
 			"git_provider": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Git provider name",
 			},
 			"git_provider_api_url": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Git provider API url",
 			},
 			"shared_config_repository": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Shared config repository url",
 			},
 			"admins": {

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(),
 	}

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(),
 	}

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": {

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,

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,

codefresh/resource_account_gitops_settings.go

@@ -24,9 +24,9 @@ func resourceAccountGitopsSettings() *schema.Resource {
 		Delete: resourceAccountGitopsSettingsDelete,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Type:     schema.TypeString,
+				Type:        schema.TypeString,
 				Description: "Account Id",
-				Computed: true,
+				Computed:    true,
 			},
 			"name": {
 				Type:        schema.TypeString,

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,

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,

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
 

docs/data-sources/idps.md

@@ -2,12 +2,12 @@
 page_title: "codefresh_idps Data Source - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  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.
 ---
 
 # 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
 

docs/data-sources/user.md

@@ -2,12 +2,12 @@
 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)
 
-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.
 
 ## Example usage
 

docs/data-sources/users.md

@@ -2,12 +2,12 @@
 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)
 
-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.
 
 ## Example usage
 

docs/resources/account.md

@@ -2,12 +2,12 @@
 page_title: "codefresh_account Resource - terraform-provider-codefresh"
 subcategory: ""
 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.
 ---
 
 # 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/).
 

docs/resources/account_admins.md

@@ -2,12 +2,12 @@
 page_title: "codefresh_account_admins Resource - terraform-provider-codefresh"
 subcategory: ""
 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.
 ---
 
 # 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
 

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.
 

docs/resources/api_key.md

@@ -3,11 +3,13 @@ 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.
 ---
 
 # 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. 
 This resource requires Codefresh system admin permissions, hence is relevant for on-prem deployments of Codefresh only.

docs/resources/user.md

@@ -2,12 +2,12 @@
 page_title: "codefresh_user Resource - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  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.
 ---
 
 # 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.
 
 
 

templates/resources/account_gitops_settings.md.tmpl

@@ -26,7 +26,7 @@ resource "codefresh_account_gitops_settings" "gitops-settings" {
 
 {{ .SchemaMarkdown | trimspace }}
 
-[!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.