Skip to content

Commit e75d698

Browse files
committed
Add docs for policies, swift passwords, group memberships, and update a couple others
1 parent ae6d421 commit e75d698

File tree

8 files changed

+158
-3
lines changed

8 files changed

+158
-3
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# baremetal\_identity\_policies
2+
3+
Lists policies
4+
5+
## Example Usage
6+
7+
```
8+
data "baremetal_identity_policies" "p" {
9+
compartment_id = "compartment ocid"
10+
}
11+
```
12+
13+
## Argument Reference
14+
15+
The following arguments are supported:
16+
17+
* `compartment_id` - (Required) The OCID of the compartment.
18+
19+
## Attribute Reference
20+
* `policies` - A list of policies
21+
22+
## Group Reference
23+
* `id` - The OCID of the policy.
24+
* `compartment_id` - The OCID of the compartment containing the policy (either the tenancy or another compartment).
25+
* `name` - The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.
26+
* `description` - The description you assign to the policy. Does not have to be unique, and it's changeable.
27+
* `time_created` - Date and time the policy was created.
28+
* `state` - The group's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
29+
* `inactive_status` - The detailed status of INACTIVE lifecycleState.
30+
* `version_date` - The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# baremetal\_identity\_swift\_passwords
2+
3+
Lists swift passwords
4+
5+
## Example Usage
6+
7+
```
8+
data "baremetal_identity_swift_passwords" "p" {
9+
compartment_id = "compartment ocid"
10+
user_id = "user ocid"
11+
}
12+
```
13+
14+
## Argument Reference
15+
16+
The following arguments are supported:
17+
18+
* `compartment_id` - (Required) The OCID of the compartment container the user.
19+
* `group_id` - (Optional) The OCID of the group. At least one of group_id or user_id is required.
20+
* `user_id` - (Optional) The OCID of the user. At least one of group_id or user_id is required.
21+
22+
## Attribute Reference
23+
* `passwords` - A list of swift passwords
24+
25+
## Swift Password Reference
26+
* `id` - The OCID of the Swift password.
27+
* `user_id` - The OCID of the user the password belongs to.
28+
* `password` - The Swift password. The value is available only in the response for CreateSwiftPassword, and not for ListSwiftPasswords or UpdateSwiftPassword.
29+
* `description` - The description you assign to the Swift password. Does not have to be unique, and it's changeable.
30+
* `expires_on` - Date and time the password will expire, in the format defined by RFC3339.
31+
* `time_created` - Date and time the password was created, in the format defined by RFC3339.
32+
* `state` - The membership's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
33+
* `inactive_status` - The detailed status of INACTIVE lifecycleState.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# baremetal\_identity\_user_group_memberships
2+
3+
Lists user_group_memberships
4+
5+
## Example Usage
6+
7+
```
8+
data "baremetal_identity_user_group_memberships" "g_memberships" {
9+
compartment_id = "cid"
10+
group_id = "${baremetal_identity_group.g.id}"
11+
}`
12+
```
13+
14+
## Argument Reference
15+
16+
The following arguments are supported:
17+
18+
* `compartment_id` - (Required) The OCID of the tenancy containing the user, group, and membership object.
19+
* `group_id` - (Optional) The OCID of the group. At least one of group_id or user_id is required.
20+
* `user_id` - (Optional) The OCID of the user. At least one of group_id or user_id is required.
21+
22+
## Attribute Reference
23+
* `memberships` - A list of user_group_memberships
24+
25+
## User Group Membership Reference
26+
* `id` - The OCID of the user.
27+
* `compartment_id` - The OCID of the tenancy containing the user.
28+
* `group_id` - The OCID of the group.
29+
* `user_id` - The OCID of the user.
30+
* `time_created` - Date and time the user was created, in the format defined by RFC3339.
31+
* `state` - The membership's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
32+
* `inactive_status` - The detailed status of INACTIVE lifecycleState.

docs/resources/core/volume.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ resource "baremetal_core_volume" "t" {
99
availability_domain = "availability_domain"
1010
compartment_id = "compartment_id"
1111
size_in_mbs = 262144
12+
volume_backup_id = "volume_id"
1213
}
1314
```
1415

@@ -19,6 +20,7 @@ The following arguments are supported:
1920
* `compartment_id` - (Required) The OCID of the compartment.
2021
* `availability_domain` - (Required) The Availability Domain of the volume.
2122
* `display_name` - (Optional) A user-friendly name. Does not have to be unique, and it's changeable.
23+
* `volume_backup_id` - (Optional) The OCID of the volume backup from which the data should be restored on the newly created volume.
2224

2325
## Attributes Reference
2426
* `availability_domain` - The availability domain of the volume.

docs/resources/identity/compartment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ resource "baremetal_identity_compartment" "t" {
1515

1616
The following arguments are supported:
1717

18-
* `name` - (Required) The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
19-
* `description` - (Required) The description you assign to the group during creation. Does not have to be unique, and it's changeable.
18+
* `name` - (Required) The name you assign to the compartment during creation. The name must be unique across all compartments in the tenancy and cannot be changed.
19+
* `description` - (Required) The description you assign to the compartment during creation. Does not have to be unique, and it's changeable.
2020

2121
## Attributes Reference
2222
* `id` - The OCID of the compartment.

docs/resources/identity/group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ The following arguments are supported:
2424
* `name` - The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
2525
* `descriptions` - The description you assign to the group. Does not have to be unique, and it's changeable.
2626
* `time_created` - Date and time the group was created.
27-
* `state` - The policy's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
27+
* `state` - The group's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
2828
* `inactive_status` - The detailed status of INACTIVE lifecycleState.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# baremetal\_identity\_swift\_password
2+
3+
Provides a swift password resource.
4+
5+
## Example Usage
6+
7+
```
8+
resource "baremetal_identity_swift_password" "t" {
9+
user_id = "user_id"
10+
description = "nah nah nah"
11+
}
12+
```
13+
14+
## Argument Reference
15+
16+
The following arguments are supported:
17+
18+
* `user_id` - (Required) The OCID of the user.
19+
* `description` - (Required) The description you assign to the Swift password. Does not have to be unique, and it's changeable.
20+
21+
## Attributes Reference
22+
* `user_id` - The OCID of the user.
23+
* `description` - The description you assign to the Swift password. Does not have to be unique, and it's changeable.
24+
* `password` - The Swift password. The value is available only in the response for CreateSwiftPassword, and not for ListSwiftPasswords or UpdateSwiftPassword.
25+
* `expires_on` - Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.
26+
* `time_created` - The date and time the password was created.
27+
* `state` - The user's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
28+
* `inactive_status` - The detailed status of INACTIVE lifecycleState.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# baremetal\_identity\_user\_group\_membership
2+
3+
Provides a user group membership resource.
4+
5+
## Example Usage
6+
7+
```
8+
resource "baremetal_identity_user_group_membership" "t" {
9+
compartment_id = "cid"
10+
user_id = "${baremetal_identity_user.u.id}"
11+
group_id = "${baremetal_identity_group.g.id}"
12+
}
13+
```
14+
15+
## Argument Reference
16+
17+
The following arguments are supported:
18+
19+
* `compartment_id` - (Required) The OCID of the tenancy containing the user, group, and membership object.
20+
* `user_id` - (Required) The OCID of the group.
21+
* `group_id` - (Required) The OCID of the user.
22+
23+
## Attributes Reference
24+
* `id` - The internet gateway's Oracle Cloud ID (OCID).
25+
* `compartment_id` - The OCID of the tenancy containing the user, group, and membership object.
26+
* `user_id` - The OCID of the user.
27+
* `group_id` - The OCID of the group.
28+
* `time_created` - The date and time the security list was created.
29+
* `state` - The user's current state. [CREATING, ACTIVE, INACTIVE, DELETING, DELETED]
30+
* `inactive_status` - Returned only if the user's lifecycleState is INACTIVE. A 16-bit value showing the reason why the user is inactive: [bit 0: SUSPENDED, bit 1: DISABLED, bit 2: BLOCKED]

0 commit comments

Comments
 (0)