Skip to content

Commit 546f684

Browse files
authored
feat: initial Observability instances DA solution (#2)
1 parent 5ebbd4c commit 546f684

39 files changed

+871
-369
lines changed

.catalog-onboard-pipeline.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
apiVersion: v1
3+
offerings:
4+
- name: deploy-arch-ibm-observability
5+
kind: solution
6+
catalog_id: 7df1e4ca-d54c-4fd0-82ce-3d13247308cd
7+
offering_id: a3137d28-79e0-479d-8a24-758ebd5a0eab
8+
variations:
9+
- name: instances
10+
mark_ready: true
11+
install_type: fullstack
12+
scc:
13+
instance_id: 1c7d5f78-9262-44c3-b779-b28fe4d88c37
14+
region: us-south

.github/CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Primary owner should be listed first in list of global owners, follwed by any secondary owners
2+
* @maheshwarishikha @iamar7

.github/settings.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ repository:
1515
# By changing this field, you rename the repository.
1616

1717
# Uncomment this name property and set the name to the current repo name.
18-
# name: ""
18+
name: "terraform-ibm-observability-da"
1919

2020
# The description is displayed under the repository name on the
2121
# organization page and in the 'About' section of the repository.
2222

2323
# Uncomment this description property
2424
# and update the description to the current repo description.
25-
# description: ""
25+
description: "A deployable architecture solution to deploy Observability instances and agents."
2626

2727
# Use a comma-separated list of topics to set on the repo (ensure not to use any caps in the topic string).
28-
topics: terraform, ibm-cloud, terraform-module
28+
topics: core-team, terraform, ibm-cloud, observability, supported, deployable-architecture

.releaserc

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
}],
1111
["@semantic-release/exec", {
1212
"successCmd": "echo \"SEMVER_VERSION=${nextRelease.version}\" >> $GITHUB_ENV"
13+
}],
14+
["@semantic-release/exec", {
15+
"publishCmd": "./ci/trigger-catalog-onboarding-pipeline.sh --version=v${nextRelease.version}"
1316
}]
1417
]
1518
}

README.md

+7-102
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,16 @@
1-
<!-- Update the title -->
2-
# Terraform Modules Template Project
1+
# IBM Cloud Observability solution
32

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-
[![Incubating (Not yet consumable)](https://img.shields.io/badge/status-Incubating%20(Not%20yet%20consumable)-red)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
10-
[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-module-template?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-module-template/releases/latest)
3+
[![Stable (With quality checks)](https://img.shields.io/badge/Status-Stable%20(With%20quality%20checks)-green)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
4+
[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-observability-da?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/releases/latest)
115
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
126
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
137
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
148

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)
1712

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)
10914

11015
<!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow -->
11116
## Contributing

cra-config.yaml

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# More info about this file at https://github.com/terraform-ibm-modules/common-pipeline-assets/blob/main/.github/workflows/terraform-test-pipeline.md#cra-config-yaml
22
version: "v1"
33
CRA_TARGETS:
4-
- CRA_TARGET: "examples/complete" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
5-
CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
6-
PROFILE_ID: "0e6e7b5a-817d-4344-ab6f-e5d7a9c49520" # SCC profile ID (currently set to the FSCloud 1.4.0 profile).
7-
# SCC_INSTANCE_ID: "" # The SCC instance ID to use to download profile for CRA scan. If not provided, a default global value will be used.
8-
# SCC_REGION: "" # The IBM Cloud region that the SCC instance is in. If not provided, a default global value will be used.
9-
# CRA_ENVIRONMENT_VARIABLES: # An optional map of environment variables for CRA, where the key is the variable name and value is the value. Useful for providing TF_VARs.
10-
# TF_VAR_sample: "sample value"
11-
# TF_VAR_other: "another value"
4+
- CRA_TARGET: "solutions/instances"
5+
CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json"
6+
PROFILE_ID: "1c13d739-e09e-4bf4-8715-dd82e4498041" # SCC profile ID (currently set to CIS IBM Cloud Foundations Benchmark 1.0.0 profile).
7+
CRA_ENVIRONMENT_VARIABLES:
8+
TF_VAR_resource_group_name: "test"
9+
TF_VAR_existing_kms_guid: "XXXXXXXXXXXXXXXX"

cra-tf-validate-ignore-rules.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
{
2-
"scc_rules": []
2+
"scc_rules": [
3+
{
4+
"scc_rule_id": "rule-8cbd597c-7471-42bd-9c88-36b2696456e9",
5+
"description": "Check whether Cloud Object Storage network access is restricted to a specific IP range",
6+
"ignore_reason": "Tracking in https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/issues/6",
7+
"is_valid": true
8+
}
9+
]
310
}

examples/basic/README.md

-11
This file was deleted.

examples/basic/main.tf

-24
This file was deleted.

examples/basic/outputs.tf

-18
This file was deleted.

examples/basic/provider.tf

-8
This file was deleted.

examples/basic/variables.tf

-33
This file was deleted.

examples/basic/version.tf

-12
This file was deleted.

examples/complete/README.md

-4
This file was deleted.

examples/complete/main.tf

-3
This file was deleted.

examples/complete/outputs.tf

-23
This file was deleted.

examples/complete/provider.tf

-8
This file was deleted.

examples/complete/variables.tf

-29
This file was deleted.

examples/complete/version.tf

-12
This file was deleted.

0 commit comments

Comments
 (0)