In order to allow Crossplane to provision cloud services such as Postgres, it requires the cloud provider stack to be configured with a user account (eg: a service account in case of GCP, an IAM user in case of AWS)
In order to allow Crossplane to provision cloud services such as Postgres, it requires the cloud provider stack to be configured with a user account (eg: a service account in case of GCP, an IAM user in case of AWS).
For this guide the pre-requisites are as follows:
...
...
@@ -14,7 +14,7 @@ We will use the GCP stack as an example in this guide. The instructions for AWS
First, we need to declare some environment variables with configuration that will be used throughout this guide:
```
```sh
export PROJECT_ID=crossplane-playground # the project that all resources reside.
export NETWORK_NAME=default # the network that your GKE cluster lives in.
```
...
...
@@ -22,10 +22,10 @@ export NETWORK_NAME=default # the network that your GKE cluster lives in.
### Configure RBAC permissions
- For a non-GitLab managed cluster(s), ensure that the service account for the token provided can manage resources in the `database.crossplane.io` API group.
We need to manually grant GitLab's service account the ability to manage resources in the database.crossplane.io API group. The Aggregated ClusterRole allows us to do that
We need to manually grant GitLab's service account the ability to manage resources in the database.crossplane.io API group. The Aggregated ClusterRole allows us to do that.
First, save the following YAML as `crossplane-database-role.yaml`
```
```sh
cat> crossplane-database-role.yaml <<EOF
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
...
...
@@ -49,7 +49,9 @@ rules:
EOF
```
`kubectl apply -f crossplane-database-role.yaml`
```sh
kubectl apply -f crossplane-database-role.yaml
```
### Configure Crossplane with the cloud provider
...
...
@@ -66,7 +68,7 @@ We can either use Crossplane to achieve this as demonstrated below or directly i
- Create a GlobalAddress and Connection resources:
```
```sh
cat> network.yaml <<EOF
---
# gitlab-ad-globaladdress defines the IP range that will be allocated for cloud services connecting to the instances in the given Network.
...
...
@@ -101,14 +103,16 @@ spec:
reservedPeeringRangeRefs:
- name: gitlab-ad-globaladdress
EOF
```
```sh
kubectl apply -f network.yaml
```
You can verify creation of the network resources with the following commands.
Verify that the status of both of these resources is ready and is synced.
@@ -123,7 +127,7 @@ Resource classes are a way of defining a configuration for the required managed
1. A default CloudSQLInstanceClass.
1. A CloudSQLInstanceClass with labels.
```
```sh
cat> gcp-postgres-standard.yaml <<EOF
apiVersion: database.gcp.crossplane.io/v1beta1
kind: CloudSQLInstanceClass
...
...
@@ -169,35 +173,83 @@ specTemplate:
name: gcp-provider
reclaimPolicy: Delete
EOF
```
```sh
kubectl apply -f gcp-postgres-standard.yaml
```
Verify creation of the Resource class
```
```sh
kubectl get cloudsqlinstanceclasses
```
The Resource Classes allow you to define classes of service for a managed service. We could create another `CloudSQLInstanceClass` which requests for a larger or a faster disk. It could also request for a specific version of the database.
### AutoDevOps Configuration Options
### AutoDevOps Configuration Options
The autodevops pipeline can be run with the following options:
The Auto DevOps pipeline can be run with the following options:
1.`postgres.managed` set to true which will select a default resourceclass. The resourceclass needs to be marked with the annotation `resourceclass.crossplane.io/is-default-class: "true"` (As per the guide the CloudSQLInstanceClass `cloudsqlinstancepostgresql-standard-default` will be used to satisfy the claim )
1.`postgres.managed` set to true with `postgres.managedClassSelector` providing the resource class to choose based on labels. In this case the value of `postgres.managedClassSelector.matchLabels.gitlab-ad-demo="true"` will select the CloudSQLInstance class `cloudsqlinstancepostgresql-standard` to satisfy the claim request.
The autodevops pipeline should provision a PostgresqlInstance.
Alertnatively, the Environment variables `AUTO_DEVOPS_POSTGRES_MANAGED` and `AUTO_DEVOPS_POSTGRES_MANAGED_CLASS_SELECTOR` could also be used in the Auto DevOps pipeline.
Verify creation of the Postgres Instance
The Auto DevOps pipeline should provision a PostgresqlInstance when it runs succesfully.
```
Verify creation of the PostgresQL Instance.
```sh
kubectl get postgresqlinstance
```
### Connect to the Postgres instance
Sample Output: The `STATUS` field of the PostgresqlInstance transitions to `BOUND` when it is successfully provisioned.
```
NAME STATUS CLASS-KIND CLASS-NAME RESOURCE-KIND RESOURCE-NAME AGE
Follow this [GCP guide](https://cloud.google.com/sql/docs/postgres/connect-kubernetes-engine) if you would like to connect to the newly provisioned Postgres database instance on CloudSQL
