Skip to content

Doc 13250 Cloud Autonomous Operator IA changes #9

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

Open
wants to merge 2 commits into
base: release/2.8
Choose a base branch
from
Open
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
386 changes: 386 additions & 0 deletions modules/ROOT/assets/images/kubernettes_2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
93 changes: 93 additions & 0 deletions modules/ROOT/pages/compatibility.adoc
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions modules/ROOT/pages/install-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 9 additions & 3 deletions modules/ROOT/pages/overview.adoc
Original file line number Diff line number Diff line change
@@ -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?

Expand Down
10 changes: 9 additions & 1 deletion modules/ROOT/pages/tutorial-prometheus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down