Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulczar/gcp-cloud-compute-operator
gcp operator for kubernetes
https://github.com/paulczar/gcp-cloud-compute-operator
Last synced: about 1 month ago
JSON representation
gcp operator for kubernetes
- Host: GitHub
- URL: https://github.com/paulczar/gcp-cloud-compute-operator
- Owner: paulczar
- License: apache-2.0
- Created: 2018-11-16T19:00:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-12T17:03:59.000Z (over 3 years ago)
- Last Synced: 2024-04-14T15:08:02.236Z (2 months ago)
- Language: Go
- Size: 13.4 MB
- Stars: 28
- Watchers: 5
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-operators - paulczar/gcp-cloud-compute-operator
README
# Google Cloud Platform Operator
This is a demo operator for the [Google Cloud Platform](https://cloud.google.com) which simplifies requesting google cloud resources in the form on Kubernetes Manifests.
The goal of the Operator is to provide a bare minimum set of Kubernetes CRDs to enable provisioning GCP services. To enable this the manifest Specs are generally a 1:1 mapping to the GCP API objects.
Currently supports creating and destroying the following GCP Services:
> Note: the Kubernetes resource spec for your requests should match the GCP Go SDK
structures.
* [Compute](https://godoc.org/google.golang.org/api/compute/v1)
* [Addresses](https://godoc.org/google.golang.org/api/compute/v1#Address)
* [Images](https://godoc.org/google.golang.org/api/compute/v1#Image)
* [Firewalls](https://godoc.org/google.golang.org/api/compute/v1#Firewall)
* [Networks](https://godoc.org/google.golang.org/api/compute/v1#Network)
* [Subnetworks](https://godoc.org/google.golang.org/api/compute/v1#Subnetwork)
* [Forwarding Rules](https://godoc.org/google.golang.org/api/compute/v1#ForwardingRule)
* [Target Pools](https://godoc.org/google.golang.org/api/compute/v1#TargetPool)
* [Instances](https://godoc.org/google.golang.org/api/compute/v1#Instance)
* [IAM](https://godoc.org/google.golang.org/api/iam/v1)
* [Service Accounts](https://godoc.org/google.golang.org/api/iam/v1#ServiceAccount)
* [DNS](https://godoc.org/google.golang.org/api/dns/v1)
* [ManagedZone](https://godoc.org/google.golang.org/api/iam/v1/#ManagedZone)
* [RecordSet](https://godoc.org/google.golang.org/api/iam/v1/#RecordSet)
## Add new gcp compute service
```
API=dns.google.golang.org/v1 KIND=Record
operator-sdk add api --api-version=$API --kind=$KIND
operator-sdk add controller --api-version=$API --kind=$KIND
```
## Annotations
You can set the following Annotations:
| Annotation | Description |
| ---------- | ----------- |
| `compute.gce/project-id` | Sets the GCP Project ID if different to that used in operator service account |
| `iam.gce/serviceAccountName` | Sets the service account name for service account keys |
| `iam.gce/secretName` | Sets the secret name for service account keys |
| `iam.gce/secretNamespace` | Sets the secret namespace for service account keys |
## Example Usage
Create a namespace to run the operator in:
```bash
kubectl create namespace gcp-operator
```
Create a secret containing your GCP account credentials:
```bash
kubectl -n gcp-operator create secret \
generic gcp-operator \
--from-file=google.json=/path/to/credentials.json
```
If using GKE you need to ensure your user has the cluster admin role binding:
```bash
kubectl create clusterrolebinding cluster-admin-binding \
--clusterrole=cluster-admin --user=
clusterrolebinding.rbac.authorization.k8s.io/cluster-admin-binding created
```
Deploy the GCP Operator:
```bash
kubectl -n gcp-operator apply -f deploy/service_account.yaml
kubectl -n gcp-operator apply -f deploy/role.yaml
kubectl -n gcp-operator apply -f deploy/role_binding.yaml
kubectl -n gcp-operator apply -f deploy/operator.yaml
```
Deploy the CRDs:
```bash
kubectl apply -f deploy/crds/compute_v1_address_crd.yaml
kubectl apply -f deploy/crds/compute_v1_firewall_crd.yaml
kubectl apply -f deploy/crds/compute_v1_forwardingrule_crd.yaml
kubectl apply -f deploy/crds/compute_v1_image_crd.yaml
kubectl apply -f deploy/crds/compute_v1_instance_crd.yaml
kubectl apply -f deploy/crds/compute_v1_network_crd.yaml
kubectl apply -f deploy/crds/compute_v1_subnetwork_crd.yaml
kubectl apply -f deploy/crds/compute_v1_targetpool_crd.yaml
```
### Create GCP Address
Edit `deploy/examples/address.yaml` replacing the project ID placeholders with your GCP project.
Once the GCP Operator is deployed you can create a GCP instance:
```bash
kubectl -n gcp-operator apply -f deploy/examples/address.yaml
```
After a few minutes check to see if the new instance exists:
```bash
gcloud compute addresses list
NAME REGION ADDRESS STATUS
example us-central1 35.226.61.203 RESERVED
```
### Create GCP Instance
Once the GCP Operator is deployed you can create a GCP instance:
> Note: you'll need to edit this file first
```bash
kubectl -n gcp-operator apply -f deploy/examples/instance.yaml
```
After a few minutes check to see if the new instance exists:
```bash
gcloud compute instances list
NAME ZONE MACHINE_TYPE PREEMPTIBLE INTERNAL_IP EXTERNAL_IP STATUS
test us-central1-a custom (2 vCPU, 4.00 GiB) 10.128.0.2 RUNNING
```
Cleanup:
```
kubectl delete -f deploy
kubectl delete -f deploy/crds
kubectl delete -f deploy/examples
```