Skip to content

Commit 7525428

Browse files
committed
chore(docs): Adding example of how to bulk create stores with unique credentials per store.
1 parent 68902eb commit 7525428

File tree

16 files changed

+327
-1
lines changed

16 files changed

+327
-1
lines changed
File renamed without changes.

examples/terraform/multiple/README.md renamed to examples/terraform/multiple_same_creds/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Multiple BoschIPCamera Store Creation Example
1+
# Multiple BoschIPCamera Store Creation using Same Credentials Example
22

33
This is an example of how to create multiple camera stores in Keyfactor Command using the Keyfactor Terraform provider.
44

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5 |
6+
| <a name="requirement_keyfactor"></a> [keyfactor](#requirement\_keyfactor) | >=2.1.5 |
7+
8+
## Providers
9+
10+
| Name | Version |
11+
|------|---------|
12+
| <a name="provider_keyfactor"></a> [keyfactor](#provider\_keyfactor) | 2.1.11 |
13+
14+
## Modules
15+
16+
No modules.
17+
18+
## Resources
19+
20+
| Name | Type |
21+
|------|------|
22+
| [keyfactor_certificate_store.bosch_camera_store](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs/resources/certificate_store) | resource |
23+
| [keyfactor_agent.universal_orchestrator](https://registry.terraform.io/providers/keyfactor-pub/keyfactor/latest/docs/data-sources/agent) | data source |
24+
25+
## Inputs
26+
27+
| Name | Description | Type | Default | Required |
28+
|------|-------------|------|---------|:--------:|
29+
| <a name="input_camera_map"></a> [camera\_map](#input\_camera\_map) | A map containing the serial number to IP address, username and password of the cameras to be enrolled | <pre>map(object({<br> ip = string<br> username = string<br> password = string<br> }))</pre> | n/a | yes |
30+
| <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 |
31+
| <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 |
32+
| <a name="input_server_password"></a> [server\_password](#input\_server\_password) | The password to authenticate to the Bosch camera | `string` | n/a | yes |
33+
| <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 |
34+
| <a name="input_server_username"></a> [server\_username](#input\_server\_username) | The username to authenticate to the Bosch camera | `string` | n/a | yes |
35+
36+
## Outputs
37+
38+
No outputs.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Copyright 2024 Keyfactor
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http:#www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
.DEFAULT_GOAL := help
16+
17+
##@ Utility
18+
help: ## Display this help
19+
@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)
20+
21+
deps: ## Install deps for macos
22+
@brew install pre-commit tflint terraform terraform-docs
23+
24+
docs: ## Run terraform-docs to update module docs.
25+
@terraform-docs markdown . > MODULE.MD
26+
@terraform-docs markdown table --output-file README.md --output-mode inject .
27+
28+
lint: ## Run tflint
29+
@tflint
30+
31+
validate: ## Run terraform validate
32+
@terraform init --upgrade
33+
@terraform validate
34+
35+
precommit/add: ## Install pre-commit hook
36+
@pre-commit install
37+
38+
precommit/remove: ## Uninstall pre-commit hook
39+
@pre-commit uninstall
40+

0 commit comments

Comments
 (0)