-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for worker node customization (#164)
- Loading branch information
1 parent
7df8b1c
commit df60f29
Showing
5 changed files
with
100 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Customizing worker nodes | ||
## Configure user managed boot volume encryption | ||
Use the following configuration in `OCIMachineTemplate` to use a [customer | ||
managed boot volume encryption key][customer_managed_keys]. | ||
```yaml | ||
kind: OCIMachineTemplate | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 | ||
spec: | ||
template: | ||
spec: | ||
instanceSourceViaImageConfig: | ||
kmsKeyId: <kms-key-id> | ||
``` | ||
|
||
## Configure shielded instances | ||
Use the following configuration in `OCIMachineTemplate` to create [shielded instances][shielded_instances]. | ||
Below example is for an AMD based VM. Please read the [CAPOCI github page][github_capoci_types] PlatformConfig struct | ||
for an enumeration of all the possible configurations. | ||
|
||
```yaml | ||
kind: OCIMachineTemplate | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 | ||
spec: | ||
template: | ||
spec: | ||
platformConfig: | ||
PlatformConfigType: "AMD_VM" | ||
amdVmPlatformConfig: | ||
isSecureBootEnabled: true | ||
isTrustedPlatformModuleEnabled: true | ||
isMeasuredBootEnabled: true | ||
``` | ||
|
||
## Configure preemptible instances | ||
Use the following configuration in `OCIMachineTemplate` to create [preemtible instances][preemptible_instances]. | ||
|
||
```yaml | ||
kind: OCIMachineTemplate | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 | ||
spec: | ||
template: | ||
spec: | ||
preemptibleInstanceConfig: | ||
terminatePreemptionAction: | ||
preserveBootVolume: false | ||
``` | ||
|
||
## Configure capacity reservation | ||
Use the following configuration in `OCIMachineTemplate` to use [capacity reservations][capacity_reservations]. | ||
|
||
```yaml | ||
kind: OCIMachineTemplate | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 | ||
spec: | ||
template: | ||
spec: | ||
capacityReservationId: <capacity-reservation-id> | ||
``` | ||
|
||
## Configure Oracle Cloud Agent plugins | ||
Use the following configuration in `OCIMachineTemplate` to configure [Oracle Cloud Agent plugins][cloud_agent_plugins]. | ||
The example below enables Bastion plugin. | ||
|
||
```yaml | ||
kind: OCIMachineTemplate | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1 | ||
spec: | ||
template: | ||
spec: | ||
agentConfig: | ||
pluginsConfigs: | ||
- name: "Bastion" | ||
desiredState: "ENABLED" | ||
``` | ||
|
||
[customer_managed_keys]: https://docs.oracle.com/en-us/iaas/Content/KeyManagement/Tasks/assigningkeys.htm | ||
[shielded_instances]: https://docs.oracle.com/en-us/iaas/Content/Compute/References/shielded-instances.htm | ||
[preemptible_instances]: https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/preemptible.htm#howitworks__using | ||
[cloud_agent_plugins]: https://docs.oracle.com/en-us/iaas/Content/Compute/Tasks/manage-plugins.htm | ||
[github_capoci_types]: https://github.com/oracle/cluster-api-provider-oci/blob/main/api/v1beta1/types.go | ||
[capacity_reservations]: https://docs.oracle.com/en-us/iaas/Content/Compute/Tasks/reserve-capacity.htm |