|
1 | | -<!-- Update the title --> |
2 | | -# Terraform Modules Template Project |
| 1 | +# IBM Cloud Observability solution |
3 | 2 |
|
4 | | -<!-- |
5 | | -Update status and "latest release" badges: |
6 | | - 1. For the status options, see https://terraform-ibm-modules.github.io/documentation/#/badge-status |
7 | | - 2. Update the "latest release" badge to point to the correct module's repo. Replace "terraform-ibm-module-template" in two places. |
8 | | ---> |
9 | | -[-red)](https://terraform-ibm-modules.github.io/documentation/#/badge-status) |
10 | | -[](https://github.com/terraform-ibm-modules/terraform-ibm-module-template/releases/latest) |
| 3 | +[-green)](https://terraform-ibm-modules.github.io/documentation/#/badge-status) |
| 4 | +[](https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/releases/latest) |
11 | 5 | [](https://github.com/pre-commit/pre-commit) |
12 | 6 | [](https://renovatebot.com/) |
13 | 7 | [](https://github.com/semantic-release/semantic-release) |
14 | 8 |
|
15 | | -<!-- Add a description of module(s) in this repo --> |
16 | | -TODO: Replace me with description of the module(s) in this repo |
| 9 | +This repository contains the following infrastructure as code solutions: |
| 10 | +- [IBM Cloud Observability instances solution](./solutions/instances) |
| 11 | +- [IBM Cloud Observability agents solution](./solutions/agents) |
17 | 12 |
|
18 | | - |
19 | | -<!-- Below content is automatically populated via pre-commit hook --> |
20 | | -<!-- BEGIN OVERVIEW HOOK --> |
21 | | -## Overview |
22 | | -* [terraform-ibm-module-template](#terraform-ibm-module-template) |
23 | | -* [Examples](./examples) |
24 | | - * [Basic example](./examples/basic) |
25 | | - * [Complete example](./examples/complete) |
26 | | -* [Contributing](#contributing) |
27 | | -<!-- END OVERVIEW HOOK --> |
28 | | - |
29 | | - |
30 | | -<!-- |
31 | | -If this repo contains any reference architectures, uncomment the heading below and links to them. |
32 | | -(Usually in the `/reference-architectures` directory.) |
33 | | -See "Reference architecture" in Authoring Guidelines in the public documentation at |
34 | | -https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines?id=reference-architecture |
35 | | ---> |
36 | | -<!-- ## Reference architectures --> |
37 | | - |
38 | | - |
39 | | -<!-- This heading should always match the name of the root level module (aka the repo name) --> |
40 | | -## terraform-ibm-module-template |
41 | | - |
42 | | -### Usage |
43 | | - |
44 | | -<!-- |
45 | | -Add an example of the use of the module in the following code block. |
46 | | -
|
47 | | -Use real values instead of "var.<var_name>" or other placeholder values |
48 | | -unless real values don't help users know what to change. |
49 | | ---> |
50 | | - |
51 | | -```hcl |
52 | | -
|
53 | | -``` |
54 | | - |
55 | | -### Required IAM access policies |
56 | | - |
57 | | -<!-- PERMISSIONS REQUIRED TO RUN MODULE |
58 | | -If this module requires permissions, uncomment the following block and update |
59 | | -the sample permissions, following the format. |
60 | | -Replace the sample Account and IBM Cloud service names and roles with the |
61 | | -information in the console at |
62 | | -Manage > Access (IAM) > Access groups > Access policies. |
63 | | ---> |
64 | | - |
65 | | -<!-- |
66 | | -You need the following permissions to run this module. |
67 | | -
|
68 | | -- Account Management |
69 | | - - **Sample Account Service** service |
70 | | - - `Editor` platform access |
71 | | - - `Manager` service access |
72 | | - - IAM Services |
73 | | - - **Sample Cloud Service** service |
74 | | - - `Administrator` platform access |
75 | | ---> |
76 | | - |
77 | | -<!-- NO PERMISSIONS FOR MODULE |
78 | | -If no permissions are required for the module, uncomment the following |
79 | | -statement instead the previous block. |
80 | | ---> |
81 | | - |
82 | | -<!-- No permissions are needed to run this module.--> |
83 | | - |
84 | | - |
85 | | -<!-- Below content is automatically populated via pre-commit hook --> |
86 | | -<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
87 | | -### Requirements |
88 | | - |
89 | | -| Name | Version | |
90 | | -|------|---------| |
91 | | -| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, <1.6.0 | |
92 | | - |
93 | | -### Modules |
94 | | - |
95 | | -No modules. |
96 | | - |
97 | | -### Resources |
98 | | - |
99 | | -No resources. |
100 | | - |
101 | | -### Inputs |
102 | | - |
103 | | -No inputs. |
104 | | - |
105 | | -### Outputs |
106 | | - |
107 | | -No outputs. |
108 | | -<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 13 | +**NB:** These solutions are not intended to be called by one or more other modules since they contain a provider configurations, meaning they are not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers) |
109 | 14 |
|
110 | 15 | <!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow --> |
111 | 16 | ## Contributing |
|
0 commit comments