|
1 | | -<!-- Update this title with a descriptive name. Use sentence case. --> |
2 | | -# Terraform modules template project |
| 1 | +# VPC Private-path External Connectivity |
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 | 3 | [-red)](https://terraform-ibm-modules.github.io/documentation/#/badge-status) |
10 | | -[](https://github.com/terraform-ibm-modules/terraform-ibm-vpc-private-path-external-connectivity/releases/latest) |
| 4 | +[](https://github.com/terraform-ibm-modules/sample-deployable-architectures/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 | | -<!-- |
16 | | -Add a description of modules in this repo. |
17 | | -Expand on the repo short description in the .github/settings.yml file. |
| 9 | +This repository contains the following sample deployable architectures: |
| 10 | +- [Cloud essentials for private-path external connectivity](./solutions/fully-configurable) |
18 | 11 |
|
19 | | -For information, see "Module names and descriptions" at |
20 | | -https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines?id=module-names-and-descriptions |
21 | | ---> |
| 12 | +:exclamation: **Important:** These solutions are not intended to be called by other modules because they contain provider configurations and are not compatible with the `for_each`, `count`, and `depends_on` Terraform arguments. For more information, see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers). |
22 | 13 |
|
23 | | -TODO: Replace this with a description of the modules in this repo. |
| 14 | +The repository includes the following artefacts for configuration. |
| 15 | +- [A GitHub Actions workflow to run the common CI pipeline for Terraform](./.github/workflows). For more information, see the common-pipeline-assets [readme file](https://github.com/terraform-ibm-modules/common-pipeline-assets/blob/main/README.md)). |
| 16 | +- A [common-dev-assets](./common-dev-assets) Git submodule with common automation that is used for CI and development. For more information, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup)). |
| 17 | +- An [ibm_catalog.json](ibm_catalog.json) file that is used for onboarding the sample deployable architectures to the IBM Cloud catalog. |
| 18 | +- A [.catalog-onboard-pipeline.yaml](.catalog-onboard-pipeline.yaml) file that is used by an IBM internal pipeline to onboard deployable architectures to the IBM catalog. |
| 19 | +- A [renovate.json](renovate.json) file that supports automatic creation of PRs to update dependencies. The Renovate pipeline runs regularly against all repos in the [terraform-ibm-modules](https://github.com/terraform-ibm-modules) org. |
24 | 20 |
|
25 | | - |
26 | | -<!-- The following content is automatically populated by the pre-commit hook --> |
27 | | -<!-- BEGIN OVERVIEW HOOK --> |
28 | | -## Overview |
29 | | -* [terraform-ibm-vpc-private-path-external-connectivity](#terraform-ibm-vpc-private-path-external-connectivity) |
30 | | -* [Examples](./examples) |
31 | | - * [Advanced example](./examples/advanced) |
32 | | - * [Basic example](./examples/basic) |
33 | | -* [Contributing](#contributing) |
34 | | -<!-- END OVERVIEW HOOK --> |
35 | | - |
36 | | - |
37 | | -<!-- |
38 | | -If this repo contains any reference architectures, uncomment the heading below and link to them. |
39 | | -(Usually in the `/reference-architectures` directory.) |
40 | | -See "Reference architecture" in the public documentation at |
41 | | -https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines?id=reference-architecture |
42 | | ---> |
43 | | -<!-- ## Reference architectures --> |
44 | | - |
45 | | - |
46 | | -<!-- Replace this heading with the name of the root level module (the repo name) --> |
47 | | -## terraform-ibm-vpc-private-path-external-connectivity |
48 | | - |
49 | | -### Usage |
50 | | - |
51 | | -<!-- |
52 | | -Add an example of the use of the module in the following code block. |
53 | | -
|
54 | | -Use real values instead of "var.<var_name>" or other placeholder values |
55 | | -unless real values don't help users know what to change. |
56 | | ---> |
57 | | - |
58 | | -```hcl |
59 | | -terraform { |
60 | | - required_version = ">= 1.9.0" |
61 | | - required_providers { |
62 | | - ibm = { |
63 | | - source = "IBM-Cloud/ibm" |
64 | | - version = "X.Y.Z" # Lock into a provider version that satisfies the module constraints |
65 | | - } |
66 | | - } |
67 | | -} |
68 | | -
|
69 | | -locals { |
70 | | - region = "us-south" |
71 | | -} |
72 | | -
|
73 | | -provider "ibm" { |
74 | | - ibmcloud_api_key = "XXXXXXXXXX" # replace with apikey value |
75 | | - region = local.region |
76 | | -} |
77 | | -
|
78 | | -module "module_template" { |
79 | | - source = "terraform-ibm-modules/<replace>/ibm" |
80 | | - version = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release |
81 | | - region = local.region |
82 | | - name = "instance-name" |
83 | | - resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX" # Replace with the actual ID of resource group to use |
84 | | -} |
85 | | -``` |
86 | | - |
87 | | -### Required access policies |
88 | | - |
89 | | -<!-- PERMISSIONS REQUIRED TO RUN MODULE |
90 | | -If this module requires permissions, uncomment the following block and update |
91 | | -the sample permissions, following the format. |
92 | | -Replace the 'Sample IBM Cloud' service and roles with applicable values. |
93 | | -The required information can usually be found in the services official |
94 | | -IBM Cloud documentation. |
95 | | -To view all available service permissions, you can go in the |
96 | | -console at Manage > Access (IAM) > Access groups and click into an existing group |
97 | | -(or create a new one) and in the 'Access' tab click 'Assign access'. |
98 | | ---> |
99 | | - |
100 | | -<!-- |
101 | | -You need the following permissions to run this module: |
102 | | -
|
103 | | -- Service |
104 | | - - **Resource group only** |
105 | | - - `Viewer` access on the specific resource group |
106 | | - - **Sample IBM Cloud** service |
107 | | - - `Editor` platform access |
108 | | - - `Manager` service access |
109 | | ---> |
110 | | - |
111 | | -<!-- NO PERMISSIONS FOR MODULE |
112 | | -If no permissions are required for the module, uncomment the following |
113 | | -statement instead the previous block. |
114 | | ---> |
115 | | - |
116 | | -<!-- No permissions are needed to run this module.--> |
117 | | - |
118 | | - |
119 | | -<!-- The following content is automatically populated by the pre-commit hook --> |
120 | | -<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
121 | | -### Requirements |
122 | | - |
123 | | -| Name | Version | |
124 | | -|------|---------| |
125 | | -| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 | |
126 | | -| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.71.2, < 2.0.0 | |
127 | | - |
128 | | -### Modules |
129 | | - |
130 | | -No modules. |
131 | | - |
132 | | -### Resources |
133 | | - |
134 | | -| Name | Type | |
135 | | -|------|------| |
136 | | -| [ibm_resource_instance.cos_instance](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_instance) | resource | |
137 | | - |
138 | | -### Inputs |
139 | | - |
140 | | -| Name | Description | Type | Default | Required | |
141 | | -|------|-------------|------|---------|:--------:| |
142 | | -| <a name="input_name"></a> [name](#input\_name) | A descriptive name used to identify the resource instance. | `string` | n/a | yes | |
143 | | -| <a name="input_plan"></a> [plan](#input\_plan) | The name of the plan type supported by service. | `string` | `"standard"` | no | |
144 | | -| <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The ID of the resource group where you want to create the service. | `string` | n/a | yes | |
145 | | -| <a name="input_resource_tags"></a> [resource\_tags](#input\_resource\_tags) | List of resource tag to associate with the instance. | `list(string)` | `[]` | no | |
146 | | - |
147 | | -### Outputs |
148 | | - |
149 | | -| Name | Description | |
150 | | -|------|-------------| |
151 | | -| <a name="output_account_id"></a> [account\_id](#output\_account\_id) | An alpha-numeric value identifying the account ID. | |
152 | | -| <a name="output_crn"></a> [crn](#output\_crn) | The CRN of the resource instance. | |
153 | | -| <a name="output_guid"></a> [guid](#output\_guid) | The GUID of the resource instance. | |
154 | | -| <a name="output_id"></a> [id](#output\_id) | The unique identifier of the resource instance. | |
155 | | -<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
156 | | - |
157 | | -<!-- Leave this section as is so that your module has a link to local development environment set-up steps for contributors to follow --> |
| 21 | +<!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow --> |
158 | 22 | ## Contributing |
159 | 23 |
|
160 | 24 | You can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md). |
|
0 commit comments