From a6a7da85a94e6bfddb4e00d39453e7a9c4596269 Mon Sep 17 00:00:00 2001 From: nikhilsbhat Date: Sun, 19 Feb 2023 14:24:45 +0530 Subject: [PATCH] Update provider documents with updated descriptions --- docs/data-sources/auth_config.md | 8 ++++---- docs/data-sources/config_repository.md | 10 +++++----- docs/data-sources/plugin_setting.md | 4 ++-- docs/index.md | 5 ++++- docs/resources/config_repository.md | 6 +++--- docs/resources/plugin_setting.md | 4 ++-- examples/provider.tf | 2 +- 7 files changed, 21 insertions(+), 18 deletions(-) diff --git a/docs/data-sources/auth_config.md b/docs/data-sources/auth_config.md index 7b73ae2..808a973 100644 --- a/docs/data-sources/auth_config.md +++ b/docs/data-sources/auth_config.md @@ -17,14 +17,14 @@ description: |- ### Required -- `profile_id` (String) The identifier of the elastic agent profile. +- `profile_id` (String) The identifier of the authorization configuration. ### Optional - `allow_only_known_users_to_login` (Boolean) Allow only those users to login who have explicitly been added by an administrator. -- `etag` (String) Etag used to track the authorisation configuration. -- `plugin_id` (String) The plugin identifier of the cluster profile. -- `properties` (Block List) the list of configuration properties that represent the configuration of this profile. (see [below for nested schema](#nestedblock--properties)) +- `etag` (String) Etag used to track the authorization configuration. +- `plugin_id` (String) The plugin identifier of the authorization plugin. +- `properties` (Block List) The list of configuration properties that represent the configuration of this authorization configuration. (see [below for nested schema](#nestedblock--properties)) ### Read-Only diff --git a/docs/data-sources/config_repository.md b/docs/data-sources/config_repository.md index 1778ad8..04c3f41 100644 --- a/docs/data-sources/config_repository.md +++ b/docs/data-sources/config_repository.md @@ -17,13 +17,13 @@ description: |- ### Required -- `profile_id` (String) The identifier of the elastic agent profile. +- `profile_id` (String) The identifier of the config repository. ### Optional -- `configuration` (Block List) the list of configuration properties that represent the configuration of this profile. (see [below for nested schema](#nestedblock--configuration)) -- `etag` (String) Etag used to track the plugin settings -- `plugin_id` (String) The plugin identifier of the cluster profile. +- `configuration` (Block List) The list of properties (key-value pairs) to be provided for using the plugin. (see [below for nested schema](#nestedblock--configuration)) +- `etag` (String) Etag used to track the config repository. +- `plugin_id` (String) The name of the config repo plugin. ### Read-Only @@ -38,7 +38,7 @@ Optional: - `encrypted_value` (String) The encrypted value of the property - `is_secure` (Boolean) Specify whether the given property is secure or not. If true and encrypted_value is not specified, GoCD will store the value in encrypted format. -- `key` (String) the name of the property key. +- `key` (String) The name of the property key. - `value` (String) The value of the property diff --git a/docs/data-sources/plugin_setting.md b/docs/data-sources/plugin_setting.md index 1527786..ece93e2 100644 --- a/docs/data-sources/plugin_setting.md +++ b/docs/data-sources/plugin_setting.md @@ -18,8 +18,8 @@ description: |- ### Optional - `configuration` (Block List) List of configuration required to configure the plugin settings. (see [below for nested schema](#nestedblock--configuration)) -- `etag` (String) Etag used to track the cluster profile -- `plugin_id` (String) The plugin identifier of the cluster profile. +- `etag` (String) Etag used to track the plugin settings. +- `plugin_id` (String) The unique identifier of the plugin. ### Read-Only diff --git a/docs/index.md b/docs/index.md index 415e5d4..e3ce56f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,6 +21,10 @@ provider "gocd" { ## Schema +### Required + +- `username` (String) username to be used while connecting with GoCD + ### Optional - `auth_token` (String) bearer-token to be used while connecting with GoCD (API: https://api.gocd.org/current/#access-tokens, UI: https://docs.gocd.org/current/configuration/access_tokens.html) cannot co-exist with password based auth. @@ -28,4 +32,3 @@ provider "gocd" { - `ca_file` (String) CA file contents, to be used while connecting to GoCD server when CA based auth is enabled - `loglevel` (String) loglevel to be set for the api calls made to GoCD - `password` (String) password to be used while connecting with GoCD -- `username` (String) username to be used while connecting with GoCD diff --git a/docs/resources/config_repository.md b/docs/resources/config_repository.md index 8b3a41e..50021cc 100644 --- a/docs/resources/config_repository.md +++ b/docs/resources/config_repository.md @@ -19,8 +19,8 @@ description: |- - `configuration` (Block Set, Min: 1) the list of configuration properties that represent the configuration of this profile. (see [below for nested schema](#nestedblock--configuration)) - `material` (Block Set, Min: 1) The material to be used by the config repo. (see [below for nested schema](#nestedblock--material)) -- `plugin_id` (String) The plugin identifier of the cluster profile. -- `profile_id` (String) The identifier of the elastic agent profile. +- `plugin_id` (String) The name of the config repo plugin. +- `profile_id` (String) The identifier of the config repository. ### Optional @@ -28,7 +28,7 @@ description: |- ### Read-Only -- `etag` (String) Etag used to track the plugin settings +- `etag` (String) Etag used to track the config repository. - `id` (String) The ID of this resource. diff --git a/docs/resources/plugin_setting.md b/docs/resources/plugin_setting.md index e220027..2c1462c 100644 --- a/docs/resources/plugin_setting.md +++ b/docs/resources/plugin_setting.md @@ -18,7 +18,7 @@ description: |- ### Required - `plugin_configurations` (Block Set, Min: 1) list of configurations to be applied to GoCD plugin (see [below for nested schema](#nestedblock--plugin_configurations)) -- `plugin_id` (String) id of the GoCD plugin to which the settings to be applied +- `plugin_id` (String) ID of the GoCD plugin to which the settings to be applied ### Read-Only @@ -30,7 +30,7 @@ description: |- Required: -- `key` (String) the name of the property key. +- `key` (String) The name of the property key. Optional: diff --git a/examples/provider.tf b/examples/provider.tf index 0fba790..e5ea031 100644 --- a/examples/provider.tf +++ b/examples/provider.tf @@ -10,7 +10,7 @@ terraform { provider "gocd" { base_url = "http://localhost:8153/go" username = "admin" - password = "admin" +// password = "admin" auth_token = "d8fccbc997d04e917b1490af8e7bf46290ab8c99" loglevel = "debug" } \ No newline at end of file