hybrid_platforms_conductor 32.12.0 → 32.13.0

data/docs/plugins/report/confluence.md

@@ -0,0 +1,49 @@
+# Report plugin: `confluence`
+
+The `confluence` report plugin is publishing inventory information in a Confluence page.
+
+## Config DSL extension
+
+### `confluence`
+
+Define a Confluence installation to be targeted.
+
+It takes the following parameters:
+* **url** (`String`): URL to the Confluence server
+* **inventory_report_page_id** (`String` or `nil`): Confluence page id used for inventory reports, or nil if none [default: nil]
+
+Example:
+```ruby
+# Confluence configuration
+confluence(
+  url: 'https://my_confluence.my_domain.com/confluence',
+  # Inventory report page ID
+  inventory_report_page_id: '12345678'
+)
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+| `confluence` | Used to connect to the Confluence API |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+| `hostname` | `String` | The node's hostname |
+| `host_ip` | `String` | The node's IP |
+| `physical` | `Boolean` | Is the node a physical host? |
+| `image` | `String` | OS image name associated to the node |
+| `description` | `String` | Node's description |
+| `services` | `Array<String>` | List of services present on the node |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/report/mediawiki.md

@@ -0,0 +1,28 @@
+# Report plugin: `mediawiki`
+
+The `mediawiki` report plugin is generating inventory information in the format of a Mediawiki page.
+It outputs the page on stdout. It is then meant to be copy/pasted in a Mediawiki page.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+| * | Any | A lot of metadata is being used in this report. Check [the plugin's code](../../../lib/hybrid_platforms_conductor/hpc_plugins/report/mediawiki.rb) defining the metadata to be displayed. |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/report/stdout.md

@@ -0,0 +1,32 @@
+# Report plugin: `stdout`
+
+The `stdout` report plugin is outputing inventory information on stdout.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+| `hostname` | `String` | The node's hostname |
+| `host_ip` | `String` | The node's IP |
+| `physical` | `Boolean` | Is the node a physical host? |
+| `image` | `String` | OS image name associated to the node |
+| `description` | `String` | Node's description |
+| `services` | `Array<String>` | List of services present on the node |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/bitbucket_conf.md

@@ -0,0 +1,97 @@
+# Test plugin: `bitbucket_conf`
+
+The `bitbucket_conf` test plugin is checking development workflow's configuration on Bitbucket instances.
+It checks branch permissions, reviewers, branch strategies... are set correctly on repositories.
+
+## Config DSL extension
+
+### `bitbucket_repos`
+
+Define a Bitbucket installation to be targeted.
+
+It takes the following parameters:
+* **url** (`String`): URL to the Bitbucket server
+* **project** (`String`): Project name from the Bitbucket server, storing repositories
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or :all for all [default: :all]
+* **checks** (`Hash<Symbol, Object>`): Checks definition to be perform on those repositories [default: {}]
+  * **branch_permissions** (`Array< Hash<Symbol, Object> >`): List of branch permissions to check [optional]
+    * **type** (`String`): Type of branch permissions to check. Examples of values are 'fast-forward-only', 'no-deletes', 'pull-request-only'.
+    * **branch** (`String`): Branch on which those permissions apply.
+    * **exempted_users** (`Array<String>`): List of exempted users for this permission [default: []]
+    * **exempted_groups** (`Array<String>`): List of exempted groups for this permission [default: []]
+    * **exempted_keys** (`Array<String>`): List of exempted access keys for this permission [default: []]
+  * **pr_settings** (`Hash<Symbol, Object>`): PR specific settings to check [optional]
+    * **required_approvers** (`Integer`): Number of required approvers [optional]
+    * **required_builds** (`Integer`): Number of required successful builds [optional]
+    * **default_merge_strategy** (`String`): Name of the default merge strategy. Example: 'rebase-no-ff' [optional]
+    * **mandatory_default_reviewers** (`Array<String>`): List of mandatory reviewers to check [default: []]
+
+Example:
+```ruby
+bitbucket_repos(
+  # Bitbucket root URL
+  url: 'https://my_bitbucket.my_domain.com/git',
+  # Bitbucket's project containing repositories
+  project: 'PRJ',
+  # List of repositories to check
+  repos: [
+    'my-platform-repo',
+    'my-chef-repo',
+    'my-hpc-plugins'
+  ],
+  checks: {
+    # master should be protected expect for the ci-adm user
+    branch_permissions: [
+      {
+        type: 'fast-forward-only',
+        branch: 'master',
+        exempted_users: ['ci-adm']
+      },
+      {
+        type: 'no-deletes',
+        branch: 'master'
+      },
+      {
+        type: 'pull-request-only',
+        branch: 'master',
+        exempted_users: ['ci-adm']
+      }
+    ],
+    # Pull requests settings
+    pr_settings: {
+      # Need 2 min approvers and 1 successful build before merge
+      required_approvers: 2,
+      required_builds: 1,
+      # We rebase and merge explicitely
+      default_merge_strategy: 'rebase-no-ff',
+      # List of reviewers
+      mandatory_default_reviewers: %w[
+        johndoe
+        mariavega
+        janedid
+        martinsmith
+      ]
+    }
+  }
+)
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+| `bitbucket` | Used to connect to the Bitbucket API |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/can_be_checked.md

@@ -0,0 +1,27 @@
+# Test plugin: `can_be_checked`
+
+The `can_be_checked` test plugin makes sure a node can be checked.
+This means that the services can be deployed in check mode (or dry run) without error.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/check_deploy_and_idempotence.md

@@ -0,0 +1,61 @@
+# Test plugin: `check_deploy_and_idempotence`
+
+The `check_deploy_and_idempotence` test plugin groups several checks on test-provisioned nodes:
+* It checks that a node can be checked when provisioned from scratch.
+* It checks that a node can be deployed when provisioned from scratch.
+* It checks that `root` account has no more access after deployment.
+* It checks that a node can be checked successfully after being deployed, and that tasks are not reporting any divergence (idempotence testing).
+
+Only 1 node per combination of services will be tested by this test plugin, as the goal is to validate the configuration recipes/playbooks by deploying on newly-provisioned nodes for test, and not on the real nodes.
+
+## Config DSL extension
+
+### `ignore_idempotence_tasks`
+
+`ignore_idempotence_tasks` defines a list of tasks that may not be idempotent during tests (meaning that checking after deploying return differences for those tasks). In such cases, those tasks will not be reported as errors by the idempotence tests.
+
+It takes a `Hash<String, String>` as a parameter, as a set of `<task_name>` => `<descriptive_reason_for_ignore>`.
+
+Example:
+```ruby
+ignore_idempotence_tasks({
+  'DNS - Create config' => '/etc/resolv.conf can\'t be changed in Docker test nodes, so checking always report it as different'
+})
+
+```
+
+### `ignore_divergent_tasks`
+
+`ignore_divergent_tasks` defines a list of tasks that may be divergent (meaning that checking nodes can return differences for those tasks). In such cases, those tasks will not be reported as errors by the idempotence or divergence tests.
+
+It takes a `Hash<String, String>` as a parameter, as a set of `<task_name>` => `<descriptive_reason_for_ignore>`.
+
+Example:
+```ruby
+for_nodes('scheduler_node') do
+  ignore_divergent_tasks({
+    'Jenkins - Create config' => 'Config file is reindented by Jenkins, so always appears different',
+    'Jenkins - Restart' => 'Jenkins is always restarted as config file is different when deploying'
+  })
+end
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+| `root_access_allowed` | `String` | If set to `true`, then skip the test for `root` access being disabled after deployment |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/check_from_scratch.md

@@ -0,0 +1,28 @@
+# Test plugin: `check_from_scratch`
+
+The `check_from_scratch` test plugin checks that a node can be checked when provisioned from scratch.
+
+Only 1 node per combination of services will be tested by this test plugin, as the goal is to validate the configuration recipes/playbooks by deploying on newly-provisioned nodes for test, and not on the real nodes.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/connection.md

@@ -0,0 +1,27 @@
+# Test plugin: `connection`
+
+The `connection` test plugin checks that a node is connectable.
+It does so by running a [`remote_bash`](../action/remote_bash.md) action on the node.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/deploy_freshness.md

@@ -0,0 +1,27 @@
+# Test plugin: `deploy_freshness`
+
+The `deploy_freshness` test plugin checks that a node has been deployed recently.
+This test can detect issues in your CD or infra-provisioning processes: a node that has not be deployed/updated/refreshed after 3 months will be reported in error.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/deploy_from_scratch.md

@@ -0,0 +1,28 @@
+# Test plugin: `deploy_from_scratch`
+
+The `deploy_from_scratch` test plugin checks that a node can be deployed when provisioned from scratch.
+
+Only 1 node per combination of services will be tested by this test plugin, as the goal is to validate the configuration recipes/playbooks by deploying on newly-provisioned nodes for test, and not on the real nodes.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/deploy_removes_root_access.md

@@ -0,0 +1,29 @@
+# Test plugin: `deploy_removes_root_access`
+
+The `deploy_removes_root_access` test plugin checks that a node that has been deployed from scratch does not have `root` access anymore.
+
+Only 1 node per combination of services will be tested by this test plugin, as the goal is to validate the configuration recipes/playbooks by deploying on newly-provisioned nodes for test, and not on the real nodes.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+| `root_access_allowed` | `String` | If set to `true`, then skip this test |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None