Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc for OKE addons and node pool cycling #290

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
- [Virtual Nodes and Enhanced Clusters](./managed/virtual-nodes-and-enhanced-clusters.md)
- [Boot volume expansion](./managed/boot-volume-expansion.md)
- [Networking customizations](./managed/networking.md)
- [Features](./managed/features.md)
- [Reference](./reference/reference.md)
- [API Reference](./reference/api-reference.md)
- [v1beta2 API](./reference/v1beta2-api.md)
Expand Down
35 changes: 35 additions & 0 deletions docs/src/managed/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Features

This page will cover configuration of various Oracle Cloud Infrastructure Container Engine for Kubernetes (OKE)
features in CAPOCI.

## Node Pool Cycling
OKE [Node Pool Cycling][node-pool-cycling] can be used during Kubernetes version upgrades to cycle
the nodes such that all the nodes of a Node Pool is running on the newer Kubernetes version. The following
`OCIManagedMachinePool` spec can be used to specify Node Pool cycling option.
```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
kind: OCIManagedMachinePool
spec:
nodePoolCyclingDetails:
isNodeCyclingEnabled: true
```

## Addons
The following `OCIManagedControlPlane` spec should be used to specify [Addons][addons] which has to be
installed in the OKE cluster.

```yaml
kind: OCIManagedControlPlane
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
spec:
clusterType: "ENHANCED_CLUSTER"
addons:
- name: CertManager
```
More details about the configuration parameters are available in [CAPOCI API Reference docs][api-reference].


[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
[addons]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengconfiguringclusteraddons.htm
[api-docs]: ../reference/api-reference.md