Skip to content

Commit 1cd9e4c

Browse files
rodrigcdevoncrouse
authored andcommitted
docs: Add clarifying examples for operator instance principal
Signed-off-by: Craig Rodrigues <[email protected]>
1 parent 73648e3 commit 1cd9e4c

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

docs/src/guide/operator_identity.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
11
# Operator: Identity
22

3-
## Authorizing the operator `instance_principal`
3+
## `instance_principal`
44

55
[Instance_principal](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm) is an IAM service feature that enables instances to be authorized actors (or principals) to perform actions on service resources. Each compute instance has its own identity, and it authenticates using the certificates that are added to it. These certificates are automatically created, assigned to instances and rotated, preventing the need for you to distribute credentials to your hosts and rotate them.
66

7+
[Dynamic Groups](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm) group OCI instances as principal actors, similar to user groups. IAM policies can then
8+
be created to allow instances in these groups to make calls against OCI infrastructure services. For example, on the operator host,
9+
this permits kubectl to access the OKE cluster.
10+
711
Any user who has access to the instance (who can SSH to the instance), automatically inherits the privileges granted to the instance. Before you enable this feature, ensure that you know who can access it, and that they should be authorized with the permissions you are granting to the instance.
812

913
By default, this feature is **disabled**. However, it is **required** at the time of cluster creation *_if_* you wish to enable [KMS Integration]() or [Extensions](./extensions.md).
1014

1115
When you enable this feature, by default, the operator host will have privileges to all resources in the compartment. If you are enabling it for [KMS Integration](), the operator host will also have rights to create policies in the root tenancy.
1216

13-
You can also turn on and off the feature at any time without impact on the operator or the cluster.
17+
## Enabling `instance_principal` for the operator instance
18+
19+
`instance_principal` for the operator instance can be enabled or disabled at any time without impact on the operator or the cluster.
20+
21+
To enable this feature, specify the following to create of the necessary IAM policies,
22+
[Dynamic Groups](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm), and [Matching Rules](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm):
23+
24+
```properties
25+
create_iam_resources = true
26+
create_iam_operator_policy = "always"
27+
```
28+
29+
To disable this feature, specify:
30+
31+
```properties
32+
create_iam_operator_policy = "never"
33+
```

0 commit comments

Comments
 (0)