Merge 04930ff into d88111b

Keyfactor · Jul 10, 2024 · 30125e3 · 30125e3
2 parents d88111b + 04930ff
commit 30125e3
Show file tree

Hide file tree

Showing 30 changed files with 1,186 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+1.0.5
+- Add examples of store creation using Keyfactor Command Terraform provider
+- Fix `integration-manifest.json` store-type definition to reflect docs
+
 1.0.4
 - Initial Public release
 

diff --git a/examples/terraform/multiple_same_creds/MODULE.MD b/examples/terraform/multiple_same_creds/MODULE.MD
@@ -0,0 +1,38 @@
+## Requirements
+
+| Name                                                                      | Version |
+|---------------------------------------------------------------------------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5  |
+| <a name="requirement_keyfactor"></a> [keyfactor](#requirement\_keyfactor) | >=2.1.5 |
+
+## Providers
+
+| Name                                                                | Version |
+|---------------------------------------------------------------------|---------|
+| <a name="provider_keyfactor"></a> [keyfactor](#provider\_keyfactor) | 2.1.11  |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name                                                                                                                                                      | Type        |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
+| [keyfactor_certificate_store.bosch_camera_store](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs/resources/certificate_store) | resource    |
+| [keyfactor_agent.universal_orchestrator](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs/data-sources/agent)                  | data source |
+
+## Inputs
+
+| Name                                                                                       | Description                                                                                                                                                            | Type          | Default | Required |
+|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------|:--------:|
+| <a name="input_camera_map"></a> [camera\_map](#input\_camera\_map)                         | A map containing the serial number to IP address of the cameras to be enrolled                                                                                         | `map(string)` | n/a     |   yes    |
+| <a name="input_inventory_schedule"></a> [inventory\_schedule](#input\_inventory\_schedule) | How often to update the inventory, valid options are number followed by 'm' for minutes, 'h' for hours, '1d' for daily, or 'immediate' for immediate inventory update. | `string`      | `"12h"` |    no    |
+| <a name="input_orchestrator_name"></a> [orchestrator\_name](#input\_orchestrator\_name)    | The name or GUID of the orchestrator that has been registered and approved in Keyfactor Command                                                                        | `string`      | n/a     |   yes    |
+| <a name="input_server_password"></a> [server\_password](#input\_server\_password)          | The password to authenticate to the Bosch camera                                                                                                                       | `string`      | n/a     |   yes    |
+| <a name="input_server_use_ssl"></a> [server\_use\_ssl](#input\_server\_use\_ssl)           | Whether to use SSL when connecting to the Bosch camera                                                                                                                 | `bool`        | `true`  |    no    |
+| <a name="input_server_username"></a> [server\_username](#input\_server\_username)          | The username to authenticate to the Bosch camera                                                                                                                       | `string`      | n/a     |   yes    |
+
+## Outputs
+
+No outputs.
diff --git a/examples/terraform/multiple_same_creds/Makefile b/examples/terraform/multiple_same_creds/Makefile
@@ -0,0 +1,40 @@
+# Copyright 2024 Keyfactor
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+.DEFAULT_GOAL := help
+
+##@ Utility
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+deps: ## Install deps for macos
+	@brew install pre-commit tflint terraform terraform-docs
+
+docs: ## Run terraform-docs to update module docs.
+	@terraform-docs markdown . > MODULE.MD
+	@terraform-docs markdown table --output-file README.md --output-mode inject .
+
+lint: ## Run tflint
+	@tflint
+
+validate: ## Run terraform validate
+	@terraform init --upgrade
+	@terraform validate
+
+precommit/add: ## Install pre-commit hook
+	@pre-commit install
+
+precommit/remove: ## Uninstall pre-commit hook
+	@pre-commit uninstall
+
diff --git a/examples/terraform/multiple_same_creds/README.md b/examples/terraform/multiple_same_creds/README.md
@@ -0,0 +1,127 @@
+# Multiple BoschIPCamera Store Creation using Same Credentials Example
+
+This is an example of how to create multiple camera stores in Keyfactor Command using the Keyfactor Terraform provider.
+
+## Pre-requisites
+
+- Terraform is installed on the machine running the Terraform code
+- The Keyfactor Terraform provider is installed and configured to communicate to Keyfactor Command. Review
+  the [Keyfactor provider documentation](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs)
+  for more information.
+- The `BIPCamera` store type is already created in Keyfactor Command. See
+  the [Extension specific documentation](https://github.com/Keyfactor/bosch-ipcamera-orchestrator?tab=readme-ov-file#store-type-configuration)
+  for more information.
+- An orchestrator with the BoschIPCamera extension is registered and approved in Keyfactor Command.
+
+## Usage
+
+Modify the `example.tfvars` file to include the necessary information for your environment. Alternatively Terraform will
+prompt for each input if no value is provided.
+
+*NOTE*: This example assumes all cameras are using the same credentials, if this does not suit your use-case then modify
+accordingly.
+
+```bash
+terraform init
+terraform plan
+terraform apply
+```
+
+### Generate tfvars file from CSV
+
+Alternatively, you can generate the `.tfvars` file from a CSV file using the template `example.csv` and running the
+python script `csv2tfvars.py`. This script will generate a `.tfvars` based on the inputs of the CSV file.
+
+#### Usage
+
+```text
+python csv2tfvars.py -h
+usage: csv2tfvars.py [-h] [-csv CSV_FILE] [-u SERVER_USERNAME] [-p SERVER_PASSWORD] [-orch ORCHESTRATOR_NAME] [-i] [output_tfvars_file]
+
+    Convert CSV to TFVARS. This script parses a given CSV file containing camera information and generates a Terraform variables file (.tfvars) with the data structured for Terraform usage.
+
+    Usage:
+        csv2tfvars.py -csv <input_csv_file> -orch <orchestrator_name> [output_tfvars_file] [-i]
+        csv2tfvars.py --help
+
+    The -i flag enables interactive mode, prompting for any missing required inputs.
+
+positional arguments:
+  output_tfvars_file    Output TFVARS file path. Optional, defaults to BoschIPCameraStores.tfvars.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -csv CSV_FILE, --csv_file CSV_FILE
+                        Path to the input CSV file. Required unless in interactive mode.
+  -u SERVER_USERNAME, --server_username SERVER_USERNAME
+                        Username for IP cameras. Required unless in interactive mode.
+  -p SERVER_PASSWORD, --server_password SERVER_PASSWORD
+                        Password for IP cameras. Required unless in interactive mode.
+  -orch ORCHESTRATOR_NAME, --orchestrator_name ORCHESTRATOR_NAME
+                        Orchestrator client name. Required unless in interactive mode.
+  -i, --interactive     Run in interactive mode. Prompts for missing inputs.
+```
+
+#### Interactive Example
+
+```bash
+python csv2tfvars.py -i
+```
+
+```text
+Enter the input CSV file path: example.csv
+Enter the server username: admin
+Enter the server password: admin
+Enter the orchestrator_name: my-uo-client-name
+Enter the output TFVARS file path (default is 'BoschIPCameraStores.tfvars'): 
+TFVARS file generated: BoschIPCameraStores.tfvars
+
+```
+
+#### Non-Interactive Example
+
+```bash
+python csv2tfvars.py -csv example.csv -orch my-uo-client-name -u camera_username -p camera_passwd
+```
+
+<!-- BEGIN_TF_DOCS -->
+
+## Requirements
+
+| Name                                                                      | Version |
+|---------------------------------------------------------------------------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5  |
+| <a name="requirement_keyfactor"></a> [keyfactor](#requirement\_keyfactor) | >=2.1.5 |
+
+## Providers
+
+| Name                                                                | Version |
+|---------------------------------------------------------------------|---------|
+| <a name="provider_keyfactor"></a> [keyfactor](#provider\_keyfactor) | 2.1.11  |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name                                                                                                                                                      | Type        |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
+| [keyfactor_certificate_store.bosch_camera_store](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs/resources/certificate_store) | resource    |
+| [keyfactor_agent.universal_orchestrator](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs/data-sources/agent)                  | data source |
+
+## Inputs
+
+| Name                                                                                       | Description                                                                                                                                                            | Type          | Default | Required |
+|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------|:--------:|
+| <a name="input_camera_map"></a> [camera\_map](#input\_camera\_map)                         | A map containing the serial number to IP address of the cameras to be enrolled                                                                                         | `map(string)` | n/a     |   yes    |
+| <a name="input_inventory_schedule"></a> [inventory\_schedule](#input\_inventory\_schedule) | How often to update the inventory, valid options are number followed by 'm' for minutes, 'h' for hours, '1d' for daily, or 'immediate' for immediate inventory update. | `string`      | `"12h"` |    no    |
+| <a name="input_orchestrator_name"></a> [orchestrator\_name](#input\_orchestrator\_name)    | The name or GUID of the orchestrator that has been registered and approved in Keyfactor Command                                                                        | `string`      | n/a     |   yes    |
+| <a name="input_server_password"></a> [server\_password](#input\_server\_password)          | The password to authenticate to the Bosch camera                                                                                                                       | `string`      | n/a     |   yes    |
+| <a name="input_server_use_ssl"></a> [server\_use\_ssl](#input\_server\_use\_ssl)           | Whether to use SSL when connecting to the Bosch camera                                                                                                                 | `bool`        | `true`  |    no    |
+| <a name="input_server_username"></a> [server\_username](#input\_server\_username)          | The username to authenticate to the Bosch camera                                                                                                                       | `string`      | n/a     |   yes    |
+
+## Outputs
+
+No outputs.
+<!-- END_TF_DOCS -->
diff --git a/examples/terraform/multiple_same_creds/agents.tf b/examples/terraform/multiple_same_creds/agents.tf
@@ -0,0 +1,17 @@
+# Copyright 2024 Keyfactor
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+data "keyfactor_agent" "universal_orchestrator" {
+  agent_identifier = var.orchestrator_name
+}
diff --git a/examples/terraform/multiple_same_creds/csv2tfvars.py b/examples/terraform/multiple_same_creds/csv2tfvars.py
@@ -0,0 +1,74 @@
+import argparse
+import csv
+import os
+import sys
+
+DEFAULT_OUTPUT_TFVARS_FILE = 'BoschIPCameraStores.tfvars'
+
+def validate_file_exists(file_path):
+    if not os.path.exists(file_path):
+        print(f"Error: The file '{file_path}' does not exist.")
+        sys.exit(1)
+
+def get_args(interactive):
+    parser = argparse.ArgumentParser(description="""
+    Convert CSV to TFVARS. This script parses a given CSV file containing camera information and generates a Terraform variables file (.tfvars) with the data structured for Terraform usage.
+
+    Usage:
+        csv2tfvars.py -csv <input_csv_file> -orch <orchestrator_name> [output_tfvars_file] [-i]
+        csv2tfvars.py --help
+
+    The -i flag enables interactive mode, prompting for any missing required inputs.""",
+    formatter_class=argparse.RawTextHelpFormatter)
+
+    parser.add_argument('-csv', '--csv_file', type=str, required=False, help='Path to the input CSV file. Required unless in interactive mode.')
+    parser.add_argument('-u', '--server_username', type=str, required=False, help='Username for IP cameras. Required unless in interactive mode.')
+    parser.add_argument('-p', '--server_password', type=str, required=False, help='Password for IP cameras. Required unless in interactive mode.')
+    parser.add_argument('-orch', '--orchestrator_name', type=str, required=False, help='Orchestrator client name. Required unless in interactive mode.')
+    parser.add_argument('output_tfvars_file', nargs='?', default=DEFAULT_OUTPUT_TFVARS_FILE, help='Output TFVARS file path. Optional, defaults to BoschIPCameraStores.tfvars.')
+    parser.add_argument('-i', '--interactive', action='store_true', help='Run in interactive mode. Prompts for missing inputs.')
+
+    args = parser.parse_args()
+
+    if interactive:
+        if not args.csv_file:
+            args.csv_file = input("Enter the input CSV file path: ")
+        if not args.server_username:
+            args.server_username = input("Enter the server username: ")
+        if not args.server_password:
+            args.server_password = input("Enter the server password: ")
+        if not args.orchestrator_name:
+            args.orchestrator_name = input("Enter the orchestrator_name: ")
+        if args.output_tfvars_file == DEFAULT_OUTPUT_TFVARS_FILE:  # Default value
+            args.output_tfvars_file = input("Enter the output TFVARS file path (default is 'BoschIPCameraStores.tfvars'): ") or DEFAULT_OUTPUT_TFVARS_FILE
+    else:
+        if not args.csv_file or not args.orchestrator_name:
+            parser.print_help()
+            sys.exit(1)
+
+    validate_file_exists(args.csv_file)
+    return args
+
+def main():
+    args = get_args('-i' in sys.argv)
+
+    camera_map = {}
+    with open(args.csv_file, mode='r', encoding='utf-8') as csvfile:
+        reader = csv.DictReader(csvfile)
+        for row in reader:
+            camera_map[row['serial_number']] = {
+                'ip': row['ip'],
+            }
+
+    with open(args.output_tfvars_file, mode='w', encoding='utf-8') as tfvarsfile:
+        tfvarsfile.write(f'orchestrator_name="{args.orchestrator_name}"\n')
+        tfvarsfile.write(f'server_username="{args.server_username}"\n')
+        tfvarsfile.write(f'server_password="{args.server_password}"\n')
+        tfvarsfile.write('camera_map = {\n')
+        for serial, details in camera_map.items():
+            tfvarsfile.write(f'  "{serial}" = "{details["ip"]}"\n')
+        tfvarsfile.write('}\n')
+    print(f"TFVARS file generated: {args.output_tfvars_file}")
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/terraform/multiple_same_creds/example.csv b/examples/terraform/multiple_same_creds/example.csv
@@ -0,0 +1,11 @@
+serial_number,ip
+068745431065110091,192.168.0.1:4444
+068745431065110092,192.168.0.2:4444
+068745431065110093,192.168.0.3:4444
+068745431065110094,192.168.0.4:4444
+068745431065110095,192.168.0.5:4444
+068745431065110096,192.168.0.6:4444
+068745431065110097,192.168.0.7:4444
+068745431065110098,192.168.0.8:4444
+068745431065110099,192.168.0.8:4444
+068745431065110100,192.168.0.9:4444
diff --git a/examples/terraform/multiple_same_creds/example.tfvars b/examples/terraform/multiple_same_creds/example.tfvars
@@ -0,0 +1,30 @@
+# Copyright 2024 Keyfactor
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http:#www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# UNCOMMENT AND FILL IN THE FOLLOWING VARIABLES
+
+# orchestrator_name="my-uo-client-machine-name"
+# server_username="camera_username"
+# server_password="camera_password"
+# camera_map = {
+#   "068745431065110091" = "192.168.0.1:4444",
+#   "068745431065110092" = "192.168.0.2:4444",
+#   "068745431065110093" = "192.168.0.3:4444",
+#   "068745431065110094" = "192.168.0.4:4444",
+#   "068745431065110095" = "192.168.0.5:4444",
+#   "068745431065110096" = "192.168.0.6:4444",
+#   "068745431065110097" = "192.168.0.7:4444",
+#   "068745431065110098" = "192.168.0.8:4444",
+#   "068745431065110099" = "192.168.0.8:4444",
+# }
diff --git a/examples/terraform/multiple_same_creds/main.tf b/examples/terraform/multiple_same_creds/main.tf
@@ -0,0 +1,25 @@
+# Copyright 2024 Keyfactor
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+resource "keyfactor_certificate_store" "bosch_camera_store" {
+  for_each           = var.camera_map
+  client_machine = each.value //this is camera IP
+  store_path = each.key //this is camera serial number
+  agent_identifier   = data.keyfactor_agent.universal_orchestrator.agent_identifier
+  store_type = "BIPCamera" # Must exist in KeyFactor Command
+  server_username    = var.server_username
+  server_password    = var.server_password
+  server_use_ssl     = var.server_use_ssl
+  inventory_schedule = var.inventory_schedule
+}