Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/presslabs/wordpress-operator
Bitpoke Kubernetes operator for WordPress
https://github.com/presslabs/wordpress-operator
kubebuilder kubernetes kubernetes-controller kubernetes-operator wordpress
Last synced: 3 months ago
JSON representation
Bitpoke Kubernetes operator for WordPress
- Host: GitHub
- URL: https://github.com/presslabs/wordpress-operator
- Owner: bitpoke
- License: apache-2.0
- Created: 2018-04-25T12:18:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T23:37:44.000Z (about 1 year ago)
- Last Synced: 2024-05-22T14:32:33.283Z (6 months ago)
- Topics: kubebuilder, kubernetes, kubernetes-controller, kubernetes-operator, wordpress
- Language: Go
- Homepage:
- Size: 34.2 MB
- Stars: 213
- Watchers: 14
- Forks: 32
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
wordpress-operator [](https://ci.bitpoke.io/bitpoke/wordpress-operator)
===
Bitpoke WordPress operator enables managing multiple WordPress installments at scale.
## Goals and status
The main goals of the operator are:
1. Easily deploy scalable WordPress sites on top of kubernetes
2. Allow best practices for en masse upgrades (canary, slow rollout, etc.)
3. Friendly to devops (monitoring, availability, scalability and backup stories solved)
The project is actively developed and maintained and has reached stable beta state. Check [here](https://github.com/bitpoke/wordpress-operator/releases) the project releases.
The minimum supported Kubernetes version is 1.19.
## Components
1. WordPress operator - this project
2. WordPress runtime - container image supporting the project goals (https://github.com/bitpoke/stack-runtimes/tree/master/wordpress)
## Deploy
### Install CRDs
#### This step is optional. By default helm will install CRDs.
Install kustomize. New to kustomize? Check https://kustomize.io/
Install kubectl. For more details, see: https://kubernetes.io/docs/tasks/tools/install-kubectl/
To install CRDs use the following command:
```shell
kubectl apply -f https://raw.githubusercontent.com/bitpoke/wordpress-operator/master/config/crd/bases/wordpress.presslabs.org_wordpresses.yaml
```
### Install controller
Install helm. New to helm? Check https://github.com/helm/helm#install
To deploy this controller, use the provided helm chart, by running:
```shell
helm repo add bitpoke https://helm-charts.bitpoke.io
helm install wordpress-operator bitpoke/wordpress-operator
```
## Deploying a WordPress Site
```yaml
apiVersion: wordpress.presslabs.org/v1alpha1
kind: Wordpress
metadata:
name: mysite
spec:
replicas: 3
domains:
- example.com
# image: docker.io/bitpoke/wordpress-runtime
# tag: latest
code: # where to find the code
# contentSubpath: wp-content/
# by default, code get's an empty dir. Can be one of the following:
git:
repository: https://github.com/example.com
# reference: master
# env:
# - name: SSH_RSA_PRIVATE_KEY
# valueFrom:
# secretKeyRef:
# name: mysite
# key: id_rsa
# persistentVolumeClaim: {}
# hostPath: {}
# emptyDir: {} (default)
media: # where to find the media files
# by default, code get's an empty dir. Can be one of the following:
gcs: # store files using Google Cloud Storage
bucket: calins-wordpress-runtime-playground
prefix: mysite/
env:
- name: GOOGLE_CREDENTIALS
valueFrom:
secretKeyRef:
name: mysite
key: google_application_credentials.json
- name: GOOGLE_PROJECT_ID
value: development
# persistentVolumeClaim: {}
# hostPath: {}
# emptyDir: {}
bootstrap: # wordpress install config
env:
- name: WORDPRESS_BOOTSTRAP_USER
valueFrom:
secretKeyRef:
name: mysite
key: USER
- name: WORDPRESS_BOOTSTRAP_PASSWORD
valueFrom:
secretKeyRef:
name: mysite
key: PASSWORD
- name: WORDPRESS_BOOTSTRAP_EMAIL
valueFrom:
secretKeyRef:
name: mysite
key: EMAIL
- name: WORDPRESS_BOOTSTRAP_TITLE
valueFrom:
secretKeyRef:
name: mysite
key: TITLE
# extra volumes for the WordPress container
volumes: []
# extra volume mounts for the WordPress container
volumeMounts: []
# extra env variables for the WordPress container
env:
- name: DB_HOST
value: mysite-mysql
- name: DB_USER
valueFrom:
secretKeyRef: mysite-mysql
key: USER
- name: DB_PASSWORD
valueFrom:
secretKeyRef: mysite-mysql
key: PASSWORD
- name: DB_NAME
valueFrom:
secretKeyRef: mysite-mysql
key: DATABASE
envFrom: []
# secret containg HTTPS certificate
tlsSecretRef: mysite-tls
# extra ingress annotations
ingressAnnotations: {}
```
## License
This project is licensed under Apache 2.0 license. Read the [LICENSE](LICENSE) file in the
top distribution directory, for the full license text.