Implement comments

This commit is contained in:
lcaggio 2022-09-01 15:18:50 +02:00
parent e5878723e2
commit 9c03c8f205
3 changed files with 20 additions and 5 deletions

View File

@ -33,12 +33,14 @@ Groups configuration should be placed in a set of yaml files. The name of the fi
Within each file, the group entry structure is following: Within each file, the group entry structure is following:
```yaml ```yaml
display_name: # Group display name. display_name: Group 1 # Group display name.
description: # Group description. description: Group 1 description # Group description.
members: # List of group members. members: # List of group members.
- user_1@example.com
- user_2@example.com
managers: # List of group managers. managers: # List of group managers.
- manager_1@example.com
``` ```
<!-- BEGIN TFDOC --> <!-- BEGIN TFDOC -->
## Variables ## Variables
@ -46,6 +48,12 @@ managers: # List of group managers.
| name | description | type | required | default | | name | description | type | required | default |
|---|---|:---:|:---:|:---:| |---|---|:---:|:---:|:---:|
| [customer_id](variables.tf#L17) | Directory customer ID in the form customers/C0xxxxxxx. | <code>string</code> | ✓ | | | [customer_id](variables.tf#L17) | Directory customer ID in the form customers/C0xxxxxxx. | <code>string</code> | ✓ | |
| [data_dir](variables.tf#L22) | Relative path for the folder storing configuration data. | <code>string</code> | | <code>&#34;data&#34;</code> | | [data_dir](variables.tf#L22) | Relative path for the folder storing configuration data. | <code>string</code> | ✓ | |
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [group_id](outputs.tf#L17) | Group name => Group ID mapping. | |
<!-- END TFDOC --> <!-- END TFDOC -->

View File

@ -13,3 +13,11 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
output "group_id" {
description = "Group name => Group ID mapping."
value = {
for k in module.group :
k.name => k.id
}
}

View File

@ -22,6 +22,5 @@ variable "customer_id" {
variable "data_dir" { variable "data_dir" {
description = "Relative path for the folder storing configuration data." description = "Relative path for the folder storing configuration data."
type = string type = string
default = "data"
} }