public-cloud-databases-operator

public-cloud-databases-operator

This operator allow you to automaticaly authorize your Kubernetes cluster IP on your OVHcloud cloud databases service.

Requirement

Public or private network

This operator is compatible with public and private managed database.

Managed database in private mode

If the managed database is deployed in private mode, private IP addresses of the Kubernetes nodes will be trusted. The Kubernetes cluster must be deployed in the same network used by managed database.

Managed database in public mode and Kubernetes cluster without GW

If the managed database is deployed in public mode, public IP addresses of the Kubernetes nodes will be trusted.

Managed database in public mode and Kubernetes cluster with GW

The OVHcloud managed Kubernetes cluster can be configured to use a GW to reach internet. If the managed database is deployed in public mode and a GW was configured on the managed Kubernetes, the public IP address of the GW will be trusted.

To determine the public IP address of the GW used by the Kubernetes cluster, the operator will request https://ifconfig.io and use the returned IP.

In this case, the operator must be deployed in the kubernetes cluster consuming targeted managed database. If deployed outside the Kubernetes cluster, the returned IP address will be the public IP of the default GW of the machine running the operator. That can be different than the default GW used by Kubernetes nodes.

Ovh Credentials

The operator needs a secret that contains the credentials to call Ovhcloud api. Go to https://api.ovh.com/createToken/ to generate the credentials namely:

• application key
• application secret
• consumer key

Define the credentials ACL in order to be able to make these requests:

• GET /cloud/project/:projectID/database/service
• GET /cloud/project/:projectID/database/service/:serviceId
• PUT /cloud/project/:projectID/database/:engine/:serviceId

Values

Create a values.yaml to be injected in the helm chart that will be created afterwards. Region is either: ovh-eu, ovh-ca or ovh-us. You can find the file in /examples.

ovhCredentials:
  applicationKey: XXXX
  applicationSecret: XXXX
  consumerKey: XXXX
  region: XXXX

namespace: XXXX #Your Kubernetes namespace

Installation

Use the kubernetes package manager helm and the values file you created to install the operator.

helm install -f values.yaml public-cloud-databases-operator oci://registry-1.docker.io/ovhcom/public-cloud-databases-operator --version 3

That will create the operator, crd and secrets.

kubectl get deploy
NAME                                       READY   UP-TO-DATE   AVAILABLE   AGE
operator-public-cloud-databases-operator   1/1     1            1           11h

kubectl get crd databases.cloud.ovh.net
NAME                      CREATED AT
databases.cloud.ovh.net   2023-06-01T14:20:09Z

kubectl get secret ovh-credentials
NAME              TYPE     DATA   AGE
ovh-credentials   Opaque   4      12m

Create Custom Resource

Create a custom resource object using this example file. You can find the file in /examples.

apiVersion: cloud.ovh.net/v1alpha1
kind: Database
metadata:
  name: XXXX
  namespace: XXXX
spec:
  projectId: XXXX
  serviceId: XXX
  labelSelector:
    matchLabels:
      LABELNAME: LABELVALUE

The field serviceId is optional. If not set, the operator will be run against all the services of your project.

kubectl apply -f cr.yaml

Nodes Labels

You can use kubernetes labeling in order to select specific nodes that you want the operator to be run against. The created CR and the node must have the same label and value.

kubectl label nodes NODENAME1 NODENAME2 ... LABELNAME=LABELVALUE

Related links

• Contribute: https://github.com/ovh/public-cloud-databases-operator/blob/master/CONTRIBUTING.md
• Report bugs: https://github.com/ovh/public-cloud-databases-operator/issues

License

Copyright 2021 OVH SAS

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.