Skip to content

Commit b4b1660

Browse files
update docs for disk encryption (#700)
1 parent 4b8f1d3 commit b4b1660

File tree

6 files changed

+15
-8
lines changed

6 files changed

+15
-8
lines changed

api/v1alpha2/linodemachine_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ type LinodeMachineSpec struct {
7777
DataDisks map[string]*InstanceDisk `json:"dataDisks,omitempty"`
7878
// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
7979
// +kubebuilder:validation:Enum=enabled;disabled
80-
// DiskEncryption determines if the disks of the instance should be encrypted.
80+
// DiskEncryption determines if the disks of the instance should be encrypted. The default is disabled.
8181
DiskEncryption string `json:"diskEncryption,omitempty"`
8282

8383
// CredentialsRef is a reference to a Secret that contains the credentials

config/crd/bases/infrastructure.cluster.x-k8s.io_linodemachines.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ spec:
155155
type: object
156156
diskEncryption:
157157
description: DiskEncryption determines if the disks of the instance
158-
should be encrypted.
158+
should be encrypted. The default is disabled.
159159
enum:
160160
- enabled
161161
- disabled

config/crd/bases/infrastructure.cluster.x-k8s.io_linodemachinetemplates.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ spec:
145145
type: object
146146
diskEncryption:
147147
description: DiskEncryption determines if the disks of the
148-
instance should be encrypted.
148+
instance should be encrypted. The default is disabled.
149149
enum:
150150
- enabled
151151
- disabled

docs/src/reference/out.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ _Appears in:_
614614
| `firewallID` _integer_ | | | |
615615
| `osDisk` _[InstanceDisk](#instancedisk)_ | OSDisk is configuration for the root disk that includes the OS,<br />if not specified this defaults to whatever space is not taken up by the DataDisks | | |
616616
| `dataDisks` _object (keys:string, values:[InstanceDisk](#instancedisk))_ | DataDisks is a map of any additional disks to add to an instance,<br />The sum of these disks + the OSDisk must not be more than allowed on a linodes plan | | |
617-
| `diskEncryption` _string_ | DiskEncryption determines if the disks of the instance should be encrypted. | | Enum: [enabled disabled] <br /> |
617+
| `diskEncryption` _string_ | DiskEncryption determines if the disks of the instance should be encrypted. The default is disabled. | | Enum: [enabled disabled] <br /> |
618618
| `credentialsRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#secretreference-v1-core)_ | CredentialsRef is a reference to a Secret that contains the credentials<br />to use for provisioning this machine. If not supplied then these<br />credentials will be used in-order:<br /> 1. LinodeMachine<br /> 2. Owner LinodeCluster<br /> 3. Controller | | |
619619
| `configuration` _[InstanceConfiguration](#instanceconfiguration)_ | Configuration is the Akamai instance configuration OS,<br />if not specified this defaults to the default configuration associated to the instance. | | |
620620
| `placementGroupRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectreference-v1-core)_ | PlacementGroupRef is a reference to a placement group object. This makes the linode to be launched in that specific group. | | |

docs/src/topics/disks/disks.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
# Disks
22

3-
This section contains information about [OS](./os-disk.md) and [data](./data-disks.md) disk configuration in Cluster API Provider Linode
3+
This section contains information about [OS](./os-disk.md) and [data](./data-disks.md) disk configuration in Cluster API Provider Linode
4+
5+
## Disk encryption
6+
7+
By default, clusters are provisioned with disk encryption disabled.
8+
9+
For enabling disk encryption, set `spec.template.spec.diskEncryption=enabled` in your generated LinodeMachineTemplate resources when creating a CAPL cluster.
10+
11+
~~~admonish warning
12+
If you see issues with cluster creation after enabling disk encryption, reach out to customer support. Its possible its disabled for your account and needs to be manually enabled.
13+
~~~

docs/src/topics/getting-started.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@ Please refer to it for more details on environment variables used for client con
4444
For Regions and Images that do not yet support Akamai's cloud-init datasource CAPL will automatically use a stackscript shim
4545
to provision the node. If you are using a custom image ensure the [cloud_init](https://www.linode.com/docs/api/images/#image-create) flag is set correctly on it
4646
```
47-
~~~admonish warning
48-
By default, clusters are provisioned within VPC with disk encryption enabled. For Regions which do not have [VPC support](https://www.linode.com/docs/products/networking/vpc/#availability) yet, use the [VPCLess](./flavors/vpcless.md) flavor to have clusters provisioned. For disabling disk encryption, set `spec.template.spec.diskEncryption=disabled` in your generated LinodeMachineTemplate resources when creating a CAPL cluster.
49-
~~~
5047

5148
## Setup management cluster
5249
A clusterAPI management cluster is a kubernetes cluster that is responsible for managing the lifecycle of other child k8s clusters provisioned using Cluster API (CAPI). It serves as a control plane for provisioning, scaling, upgrading and deleting child kubernetes clusters.

0 commit comments

Comments
 (0)