Skip to content

Commit 59b889c

Browse files
committed
docs: added capi documentation
Signed-off-by: Ali Mukadam <ali.mukadam@oracle.com>
1 parent 47ab4de commit 59b889c

File tree

7 files changed

+43
-6
lines changed

7 files changed

+43
-6
lines changed

docs/src/SUMMARY.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,21 @@
1313
- [With Public Endpoints](./multi/pub-ep.md)
1414
- [With Private Endpoints](./multi/pri-ep.md)
1515
- [Advanced Customizations](./advanced/advanced.md)
16+
- [Cluster API](./advanced/capi.md)
17+
- [OKE](./advanced/oke.md)
18+
- [OCNE](./advanced/ocne.md)
1619
- [Control plane](./advanced/controlplane.md)
1720
- [Data plane](./advanced/dataplane.md)
1821
- [DNS](./advanced/dns.md)
22+
- [Istio]()
1923
- [Observability]()
20-
- [Prometheus]()
21-
- [Thanos](./advanced/thanos.md)
22-
- [Terraform Options](./terraformoptions.md)
24+
- [Monitoring]()
25+
- [Prometheus]()
26+
- [Enabling Thanos](./advanced/thanos.md)
27+
- [Logging]()
28+
- [Customizing OpenSearch]()
29+
- [Using fluentd]()
30+
- [Using fluent-bit]()
31+
- [Tracing with Jaeger]()
32+
- [Using Kiali]()
33+
- [Terraform Options](./terraformoptions.md)

docs/src/advanced/capi.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[uri-capi]: https://cluster-api.sigs.k8s.io/
2+
# Cluster API
3+
4+
[Cluster API (CAPI)][uri-capi] is a Kubernetes sub-project that provides a set of declarative APIs and tooling to simplify managing the lifecycle of Kubernetes clusters on multiple infrastructure providers. CAPI is particularly useful when you have to provision clusters on multiple infrastructure providers.
5+
6+
CAPI has 2 type of clusters:
7+
8+
1. A management cluster: is a Kubernetes cluster that manages the lifecycle of Workload Clusters. A Management Cluster is also where one or more providers run, and where resources such as Machines are stored.
9+
10+
2. A workload cluster: is a Kubernetes cluster whose lifecycle is managed by a Management Cluster.
11+
12+
In Verrazzano, the management cluster is typically deployed in an "Admin" cluster. The workload clusters are equivalent to managed clusters.
13+
14+
You can use CAPI to provision clusters the following type of clusters:
15+
16+
- [OKE](./advanced.md/oke.md)
17+
- [OCNE](./advanced.md/ocne.md)
18+
19+
To enable Cluster API, configure its parameter in `terraform.tfvars`:
20+
21+
``` yaml
22+
cluster_api = true
23+
```

docs/src/advanced/ocne.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# OCNE

docs/src/advanced/oke.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# OKE

docs/src/terraformoptions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
| --------- | ----------- | ----------- | ------- |
5252
| get_kubeconfigs | Whether to set up access to the clusters. Set to false on cluster creation. | bool | false |
5353
| install_verrazzano | Whether ready to install Verrazzano. Set to false on cluster creation | string | false |
54-
| verrazzano_version | Verrazzano version to install | 1.5.3 | 1.5.3 |
54+
| verrazzano_version | Verrazzano version to install | 1.6.0 | 1.6.0 |
5555
| verrazzano_profile | Verrazzano profile to install | dev/prod | dev |
5656
| verrazzano_control_plane | Whether to keep all Verrazzano control planes public or private | public/private | public |
5757
| verrazzano_data_plane | Whether to keep all Verrazzano data planes public or private | public/private | public |
@@ -74,6 +74,7 @@
7474
| prometheus | Whether to create an instance of Prometheus | bool | true |
7575
| prometheus_operator | Whether to install the Prometheus Operator | bool | true |
7676
| rancher | Whether to install Rancher | bool | true |
77+
| thanos | Whether to enable Thanos | map (string) | |
7778
| velero | Whether to install Velero | bool | false |
7879
| weblogic_operator | Whether to install WebLogic Operator | bool | false |
7980

terraform.tfvars.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ cloudinit_nodepool_common = "./cloudinit.sh"
101101

102102
# verrazzano
103103
install_verrazzano = false
104-
verrazzano_version = "1.5.3"
104+
verrazzano_version = "1.6.0"
105105
verrazzano_profile = "prod"
106106

107107
# ingress-nginx

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ variable "install_verrazzano" {
253253
}
254254

255255
variable "verrazzano_version" {
256-
default = "1.5.3"
256+
default = "1.6.0"
257257
description = "Verrazzano version to install"
258258
type = string
259259
}

0 commit comments

Comments
 (0)