Skip to content

Commit cc93896

Browse files
Add doc for OKE addons and node pool cycling (#290)
* Add doc for OKE addons and node pool cycling
1 parent afd8fd0 commit cc93896

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

docs/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
- [Virtual Nodes and Enhanced Clusters](./managed/virtual-nodes-and-enhanced-clusters.md)
4141
- [Boot volume expansion](./managed/boot-volume-expansion.md)
4242
- [Networking customizations](./managed/networking.md)
43+
- [Features](./managed/features.md)
4344
- [Reference](./reference/reference.md)
4445
- [API Reference](./reference/api-reference.md)
4546
- [v1beta2 API](./reference/v1beta2-api.md)

docs/src/managed/features.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Features
2+
3+
This page will cover configuration of various Oracle Cloud Infrastructure Container Engine for Kubernetes (OKE)
4+
features in CAPOCI.
5+
6+
## Node Pool Cycling
7+
OKE [Node Pool Cycling][node-pool-cycling] can be used during Kubernetes version upgrades to cycle
8+
the nodes such that all the nodes of a Node Pool is running on the newer Kubernetes version. The following
9+
`OCIManagedMachinePool` spec can be used to specify Node Pool cycling option.
10+
```yaml
11+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
12+
kind: OCIManagedMachinePool
13+
spec:
14+
nodePoolCyclingDetails:
15+
isNodeCyclingEnabled: true
16+
```
17+
18+
## Addons
19+
The following `OCIManagedControlPlane` spec should be used to specify [Addons][addons] which has to be
20+
installed in the OKE cluster.
21+
22+
```yaml
23+
kind: OCIManagedControlPlane
24+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
25+
spec:
26+
clusterType: "ENHANCED_CLUSTER"
27+
addons:
28+
- name: CertManager
29+
```
30+
More details about the configuration parameters are available in [CAPOCI API Reference docs][api-reference].
31+
32+
33+
[node-pool-cycling]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengupgradingk8sworkernode_topic-Performing_an_InPlace_Worker_Node_Upgrade_by_Cycling_an_Existing_Node_Pool.htm#contengupgradingk8sworkernode_topic-Performing_an_InPlace_Worker_Node_Upgrade_by_Cycling_an_Existing_Node_Pool
34+
[addons]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengconfiguringclusteraddons.htm
35+
[api-docs]: ../reference/api-reference.md

0 commit comments

Comments
 (0)