diff --git a/modules/ROOT/assets/images/cloud-native-overview.png b/modules/ROOT/assets/images/cloud-native-overview.png new file mode 100644 index 0000000..47fc052 Binary files /dev/null and b/modules/ROOT/assets/images/cloud-native-overview.png differ diff --git a/modules/ROOT/assets/images/kubernettes_2.svg b/modules/ROOT/assets/images/kubernettes_2.svg new file mode 100644 index 0000000..1add6bf --- /dev/null +++ b/modules/ROOT/assets/images/kubernettes_2.svg @@ -0,0 +1,386 @@ + + + + Slice + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 10fa530..664b6b3 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,6 +1,7 @@ .Introduction * xref:overview.adoc[Introduction] * xref:whats-new.adoc[What's New?] +* xref:compatibility.adoc[Compatibility Matrix] .Getting Started * xref:best-practices.adoc[Guidelines and Best Practices] * xref:prerequisite-and-setup.adoc[Prerequisites and System Requirements] diff --git a/modules/ROOT/pages/compatibility.adoc b/modules/ROOT/pages/compatibility.adoc new file mode 100644 index 0000000..3805b19 --- /dev/null +++ b/modules/ROOT/pages/compatibility.adoc @@ -0,0 +1,93 @@ += Couchbase Cloud-Native Database Compatibility Matrix + +[abstract] +The Couchbase Cloud-Native Database compatibility matrix describes the various cloud-native components that are compatible with each version of the Couchbase Autonomous Operator. + +Couchbase maximizes cloud-native technologies' advantages by natively integrating the Couchbase Autonomous Operator and Couchbase Service Broker to deliver a geo-distributed database platform, providing a hybrid, multi-cloud database solution for organizations. + +== Autonomous Operator Cloud-Native Compatibility + +The matrix below denotes the version of Couchbase Autonomous Operator and its compatibility with other cloud-native components. + +.Couchbase Cloud-Native Database Compatibility Matrix - _Autonomous Operator_ +[#table-cloud-native-compatibility-cao,cols="1h,1,1,1,1,1",options="header"] +|=== +| +| Kubernetes +| Helm +| Prometheus +| Service Mesh +| Fluent Bit + +| xref:1.2@operator::release-notes.adoc[Couchbase Autonomous Operator 1.2] +| https://github.com/kubernetes/kubernetes/releases/tag/v1.11.0[1.11^], https://github.com/kubernetes/kubernetes/releases/tag/v1.12.0[1.12^], https://github.com/kubernetes/kubernetes/releases/tag/v1.13.0[1.13^] +| na +| na +| na +| na + +| xref:2.0@operator::release-notes.adoc[Couchbase Autonomous Operator 2.0] +| https://github.com/kubernetes/kubernetes/releases/tag/v1.14.0[1.14^], https://github.com/kubernetes/kubernetes/releases/tag/v1.15.0[1.15^], https://github.com/kubernetes/kubernetes/releases/tag/v1.16.0[1.16^], https://github.com/kubernetes/kubernetes/releases/tag/v1.17.0[1.17^], https://github.com/kubernetes/kubernetes/releases/tag/v1.18.0[1.18^] +| https://github.com/helm/helm/releases[Helm 3.1+^] + +https://artifacthub.io/packages/helm/couchbase/couchbase-operator/2.0.0[Chart 2.0^] +| https://github.com/prometheus/prometheus/releases/tag/v2.18.0[Prometheus 2.18+^] + +https://hub.docker.com/r/couchbase/exporter/tags[Couchbase Exporter 1.0.2^] +| na +| na + +| xref:2.1@operator::release-notes.adoc[Couchbase Autonomous Operator 2.1] +| https://github.com/kubernetes/kubernetes/releases/tag/v1.15.0[1.15^], https://github.com/kubernetes/kubernetes/releases/tag/v1.16.0[1.16^], https://github.com/kubernetes/kubernetes/releases/tag/v1.17.0[1.17^], https://github.com/kubernetes/kubernetes/releases/tag/v1.18.0[1.18^], https://github.com/kubernetes/kubernetes/releases/tag/v1.19.0[1.19^] +| https://github.com/helm/helm/releases[Helm 3.1+^] + +https://artifacthub.io/packages/helm/couchbase/couchbase-operator/2.1.0[Chart 2.1^] +| https://github.com/prometheus/prometheus/releases/tag/v2.24.0[Prometheus 2.24+^] + +https://hub.docker.com/r/couchbase/exporter/tags[Couchbase Exporter 1.0.3^] +| https://github.com/istio/istio/releases/tag/1.8.1[Istio 1.8.1+^] +| na + +| xref:2.2@operator::release-notes.adoc[Couchbase Autonomous Operator 2.2] +| https://github.com/kubernetes/kubernetes/releases/tag/v1.17.0[1.17^], https://github.com/kubernetes/kubernetes/releases/tag/v1.18.0[1.18^], https://github.com/kubernetes/kubernetes/releases/tag/v1.19.0[1.19^], https://github.com/kubernetes/kubernetes/releases/tag/v1.20.0[1.20^], https://github.com/kubernetes/kubernetes/releases/tag/v1.21.0[1.21^] +| https://github.com/helm/helm/releases[Helm 3.1+^] + +https://artifacthub.io/packages/helm/couchbase/couchbase-operator/2.2.0[Chart 2.2^] +| https://github.com/prometheus/prometheus/releases/tag/v2.27.0[Prometheus 2.27+^] + +https://hub.docker.com/r/couchbase/exporter/tags[Couchbase Exporter 1.0.4^] +| https://github.com/istio/istio/releases/tag/1.10.0[Istio 1.10+^] +| https://fluentbit.io/announcements/v1.7.3/[Fluent Bit 1.7.3^] + +https://hub.docker.com/r/couchbase/fluent-bit/tags[Couchbase Fluent Bit 1.0.1^] +|=== + +Note: + + * The Couchbase Autonomous Operator has its own platform compatibility requirements. + Refer to xref:operator::prerequisite-and-setup.adoc[] in the Autonomous Operator documentation for more information. + + * CAO does not support Istio Service Mesh on RedHat OpenShift Container Platform. + +== Service Broker Cloud-Native Compatibility + +The matrix below denotes the version of Couchbase Service Broker and its compatibility with other cloud-native components. + +.Couchbase Cloud-Native Database Compatibility Matrix - _Service Broker_ +[#table-cloud-native-compatibility-csb,cols="1h,2,2",options="header"] +|=== +| +| Couchbase Autonomous Operator +| Open Service Broker API + +| xref:1.0@service-broker::release-notes.adoc[Couchbase Service Broker 1.0] +| xref:2.1@operator::release-notes.adoc[2.1+] +| https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/spec.md[2.13+^] + +| xref:1.1@service-broker::release-notes.adoc[Couchbase Service Broker 1.1] +| xref:1.1@service-broker::release-notes.adoc[Couchbase Service Broker 1.1] +| https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/spec.md[2.13+^] +|=== + +NOTE: The Couchbase Service Broker has its own platform compatibility requirements. +Refer to the xref:service-broker::install/get-started.adoc#prerequisites[Prerequisites] in the Service Broker documentation for more information. diff --git a/modules/ROOT/pages/install-kubernetes.adoc b/modules/ROOT/pages/install-kubernetes.adoc index 0797d51..89b6bc7 100644 --- a/modules/ROOT/pages/install-kubernetes.adoc +++ b/modules/ROOT/pages/install-kubernetes.adoc @@ -28,6 +28,21 @@ Make sure to `cd` into this directory before you run the commands in this guide. All commands in this guide are run as a system administrator account; they require the creation of cluster scoped resources or the granting of roles to service accounts (privilege escalation). +== Certified Kubernetes Platforms + +There are numerous certified Kubernetes offerings that are conformant to the https://www.cncf.io/certification/software-conformance/[CNCF Certified Kubernetes program^]. +This program ensures that every vendor’s version of Kubernetes supports the required APIs, as do open source community versions. + +Couchbase runs its own certification suites on the most widely used vendors to ensure the Couchbase Autonomous Operator is fully compatible and supported. + +The following certified Kubernetes hosted vendors are supported by the Autonomous Operator: + +* Amazon Elastic Kubernetes Service (EKS) +* Google Kubernetes Engine (GKE) +* Microsoft Azure Kubernetes Service (AKS) +* Red Hat OpenShift Container Platform +* Rancher Kubernetes Engine (RKE) + == Install the CRD The first step in installing the Operator is to install the custom resource definitions (CRD) that describe the Couchbase resource types. diff --git a/modules/ROOT/pages/overview.adoc b/modules/ROOT/pages/overview.adoc index 402997b..25e62fd 100644 --- a/modules/ROOT/pages/overview.adoc +++ b/modules/ROOT/pages/overview.adoc @@ -1,8 +1,14 @@ = Introduction -The Couchbase Autonomous Operator provides native integration of Couchbase Server with open source Kubernetes and Red Hat OpenShift. -It enables you to automate the management of common Couchbase tasks such as the configuration, creation, scaling, and recovery of Couchbase clusters. -By reducing the complexity of running a Couchbase cluster, it lets you focus on the desired configuration and not worry about the details of manual deployment and life-cycle management. +The Couchbase Cloud-Native Database is the native integration of Couchbase Server with cloud-native technologies, facilitated by the Couchbase Autonomous Operator. +This integration empowers organizations to build and run scalable stateful applications in modern, dynamic environments such as public, private, and hybrid clouds. +Containers, service meshes, microservices, immutable infrastructure, and declarative APIs exemplify this approach. + +image::kubernettes_2.svg[,400] + +The Couchbase Cloud-Native Database is the culmination of Couchbase Server and native integration with cloud-native open-source technologies such as Kubernetes, Prometheus, Helm, CNI, CoreDNS, Operator Framework, Ceph, Gluster, Istio Service Mesh, and the Open Service Broker API. + +image::cloud-native-overview.png[] == What Does it Support? diff --git a/modules/ROOT/pages/tutorial-prometheus.adoc b/modules/ROOT/pages/tutorial-prometheus.adoc index fd82adf..d77d731 100644 --- a/modules/ROOT/pages/tutorial-prometheus.adoc +++ b/modules/ROOT/pages/tutorial-prometheus.adoc @@ -5,7 +5,15 @@ Enable and setup Prometheus Monitoring for the Couchbase Autonomous Operator. include::partial$tutorial.adoc[] -This guide walks through recommended procedures for enabling and configuring Prometheus monitoring of the Couchbase Autonomous Operator. +== Overview + +https://prometheus.io/[Prometheus^] is a leading open-source monitoring solution. +As a https://www.cncf.io/announcements/2018/08/09/prometheus-graduates/[graduated project^] of the Cloud Native Computing Foundation, it has become the de facto standard for metrics collection and alert generation on cloud platforms. + +The Couchbase Autonomous Operator can optionally manage a sidecar container that can provide detailed metrics to Prometheus about the health of a Couchbase cluster. + +Prometheus provides significant visibility into the health and operation of a Couchbase cluster. +Metrics can be used to develop alerts for system issues, identify maintenance windows and other valuable business intelligence insights, as well as provide the basis for xref:operator::concept-couchbase-autoscaling.adoc[auto-scaling Couchbase clusters]. == Prerequisites