hybrid_platforms_conductor 32.12.0 → 32.13.0

data/docs/plugins/test/divergence.md

@@ -0,0 +1,41 @@
+# Test plugin: `divergence`
+
+The `divergence` test plugin checks that nodes are aligned with wanted configuration.
+It does so by issuing a check on the nodes, and reporting divergent tasks as errors.
+
+## Config DSL extension
+
+### `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
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/executables.md

@@ -0,0 +1,26 @@
+# Test plugin: `executables`
+
+The `executables` test plugin checks that all Hybrid Platforms Conductor executables are accessible and can be executed.
+
+## 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/file_system.md

@@ -0,0 +1,49 @@
+# Test plugin: `file_system`
+
+The `file_system` test plugin performs various checks on the file system of a node.
+
+## Config DSL extension
+
+### `check_files_do_exist`
+
+`check_files_do_exist` takes a path or a list of paths as parameter. Those paths should be present on the nodes and will be reported as missing if not.
+
+Example:
+```ruby
+for_nodes('/tst_.*/') do
+  check_files_do_exist '/etc/init.d', '/home/test_user'
+end
+for_nodes('/prd_.*/') do
+  check_files_do_exist '/etc/init.d'
+end
+```
+
+### `check_files_do_not_exist`
+
+`check_files_do_not_exist` takes a path or a list of paths as parameter. Those paths should be absent on the nodes and will be reported as extra if not.
+
+Example:
+```ruby
+for_nodes('/tst_.*/') do
+  check_files_do_not_exist '/tmp/wrong_file', '/home/obsolete_user'
+end
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/file_system_hdfs.md

@@ -0,0 +1,65 @@
+# Test plugin: `file_system_hdfs`
+
+The `file_system_hdfs` test plugin performs various checks on the HDFS file system of a node.
+
+## Config DSL extension
+
+### `on_hdfs`
+
+`on_hdfs` defines a configuration scope in which the `check_files_do_exist` and `check_files_do_not_exist` apply on paths from an HDFS file system.
+It takes a code block as parameter to define this scope.
+An optional argument `with_sudo` (`String`) can be specified with the sudo user name to be used in front of the hdfs commands checking for paths.
+
+Example:
+```ruby
+for_nodes('hadoop-gateway') do
+  on_hdfs(with_sudo: 'hdfs') do
+    check_files_do_not_exist '/user/obsolete_hdfs_user'
+  end
+end
+```
+
+### `check_files_do_exist`
+
+`check_files_do_exist` takes a path or a list of paths as parameter. Those paths should be present on the nodes and will be reported as missing if not.
+
+Example:
+```ruby
+for_nodes('hadoop-gateway') do
+  on_hdfs(with_sudo: 'hdfs') do
+    check_files_do_exist '/user/hadoop_user'
+  end
+end
+```
+
+### `check_files_do_not_exist`
+
+`check_files_do_not_exist` takes a path or a list of paths as parameter. Those paths should be absent on the nodes and will be reported as extra if not.
+
+Example:
+```ruby
+for_nodes('hadoop-gateway') do
+  on_hdfs(with_sudo: 'hdfs') do
+    check_files_do_not_exist '/user/obsolete_hdfs_user'
+  end
+end
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/hostname.md

@@ -0,0 +1,27 @@
+# Test plugin: `hostname`
+
+The `hostname` test plugin checks that a node's hostname corresponds to its node name.
+This test can help detect discrepancies or conflicts in the IP address or DNS spaces.
+
+## 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/idempotence.md

@@ -0,0 +1,56 @@
+# Test plugin: `idempotence`
+
+The `idempotence` test plugin checks that a node can be checked successfully after being deployed, and that tasks are not reporting any divergence.
+
+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
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/ip.md

@@ -0,0 +1,28 @@
+# Test plugin: `ip`
+
+The `ip` test plugin checks that a node's configured IP address corresponds to its metadata.
+This test can help detect discrepancies or conflicts in the IP address space.
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+| `private_ips` | `Array<String>` | List of possible private IPs the node should have |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/jenkins_ci_conf.md

@@ -0,0 +1,54 @@
+# Test plugin: `jenkins_ci_conf`
+
+The `jenkins_ci_conf` test plugin checks that Bitbucket repositories are configured properly to have their CI/CD running on a Jenkins instance, using multi-pipelines jobs.
+
+## 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
+* **jenkins_ci_url** (`String` or `nil`): Corresponding Jenkins CI URL, or nil if none.
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or :all for all [default: :all]
+
+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'
+  ],
+  # Under this URL we should have 1 multi-pipeline job per repository having its CI running on Jenkins
+  jenkins_ci_url: 'https://my_jenkins.my_domain.com/job/PRJ/'
+)
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+| `bitbucket` | Used to connect to the Bitbucket API |
+| `jenkins_ci` | Used to connect to the Jenkins instance |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/jenkins_ci_masters_ok.md

@@ -0,0 +1,54 @@
+# Test plugin: `jenkins_ci_masters_ok`
+
+The `jenkins_ci_masters_ok` test plugin checks that Bitbucket repositories CI are all having a succesful build on the current master branch.
+
+## 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
+* **jenkins_ci_url** (`String` or `nil`): Corresponding Jenkins CI URL, or nil if none.
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or :all for all [default: :all]
+
+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'
+  ],
+  # Under this URL we should have 1 multi-pipeline job per repository having its CI running on Jenkins
+  jenkins_ci_url: 'https://my_jenkins.my_domain.com/job/PRJ/'
+)
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+| `bitbucket` | Used to connect to the Bitbucket API |
+| `jenkins_ci` | Used to connect to the Jenkins instance |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/linear_strategy.md

@@ -0,0 +1,26 @@
+# Test plugin: `linear_strategy`
+
+The `linear_strategy` test plugin checks that the git repositories of your platforms follow a [git straight-line strategy](https://www.bitsnbites.eu/a-tidy-linear-git-history/).
+
+## Config DSL extension
+
+None
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+* `git`: Used to query git repository information.

data/docs/plugins/test/local_users.md

@@ -0,0 +1,48 @@
+# Test plugin: `local_users`
+
+The `local_users` test plugin checks that local Linux users on nodes are setup correctly.
+
+## Config DSL extension
+
+### `check_local_users_do_exist`
+
+Check that a given list of users do exist on a given set of nodes.
+Takes as parameter a list of Linux user names.
+
+Example:
+```ruby
+# Check users for our production nodes
+for_nodes('/prod.*/') do
+  check_local_users_do_exist %w[netadmin prodadmin]
+end
+```
+
+### `check_local_users_do_not_exist`
+
+Check that a given list of users do not exist on a given set of nodes.
+Takes as parameter a list of Linux user names.
+
+Example:
+```ruby
+# Check that obsolete users are removed from nodes
+check_local_users_do_not_exist %w[olduser1 olduser2]
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None