https://github.com/vuongxuongminh/docker-helm-yii

Containerize template for Yii.
https://github.com/vuongxuongminh/docker-helm-yii

containerize docker docker-compose helm kubernetes php yii

Last synced: 8 months ago
JSON representation

Containerize template for Yii.

Host: GitHub
URL: https://github.com/vuongxuongminh/docker-helm-yii
Owner: vuongxuongminh
License: mit
Created: 2020-05-01T16:49:23.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-31T02:47:53.000Z (over 2 years ago)
Last Synced: 2025-02-07T11:04:07.863Z (8 months ago)
Topics: containerize, docker, docker-compose, helm, kubernetes, php, yii
Language: PHP
Homepage:
Size: 259 KB
Stars: 8
Watchers: 2
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Modern containerize template for Yii

![Build Status](https://github.com/vuongxuongminh/docker-helm-yii/workflows/Docker/badge.svg)

## About it

This is a template base on `yiisoft/yii2-app-basic` (Yii2) and set of Docker services, include basic Helm chart help you save time
to start a new containerize project with Yii.

Composer package included:
+ [yiisoft/yii2-queue](https://github.com/yiisoft/yii2-queue) for working with RabbitMQ.
+ [SAM-IT/yii2-static-assets](https://github.com/SAM-IT/yii2-static-assets) for prevent publishing of assets at production time without changing your application.
+ [samdark/yii2-psr-log-target](https://github.com/samdark/yii2-psr-log-target) for working with Monolog.
+ [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv) for loads environment variables from .env to getenv(), $_ENV and $_SERVER automagically (one of the tenets of a [twelve-factor app](https://www.12factor.net/)).

## Prerequisites

+ Helm version 3.0+
+ Docker compose 1.17+
+ Docker engine 17.09+
+ Kubernetes cluster 1.14+

## Getting started

Start by downloading [distribution .tar.gz file](https://github.com/vuongxuongminh/docker-helm-yii/releases), or generate a GitHub repo from this repo.

After download and extract, open a terminal, and navigate to the directory containing your project. Run the following command to start all services using Docker Compose:

```shell script
$ docker-compose pull # Download the latest versions of the pre-built images
$ docker-compose up -d # Running in detached mode
```

This starts the following services:

| Name | Description | Ports | Environments |
|---------------|---------------------------------------------------------------------|------ |--------------|
| fpm | FastCGI process manager with PHP-FPM 7.4.5, Composer. | n/a | all |
| supervisor | Process control system with PHP 7.4.5, Supervisor 4.1.0, Composer | 9000 | all |
| nginx | Reverse proxy handle request with NGINX 1.17 | 80 | all |
| setup | Setup service help run migration & install Composer package | n/a | dev |
| filebeat | Ship logs of Nginx & FPM & Supervisor services | n/a | dev |
| elasticsearch | Store logs ship from filebeat service | n/a | dev |
| kibana | Logs viewer | 5601 | dev |
| rabbitmq | Message broker | 15672 | dev |
| mysql | Mysql database server | 3306 | dev |
| mailhog | Mail server mock | 8025 | dev |

This results in the following running containers:

```shell script
$ docker-compose ps

Name Command State Ports
------------------------------------------------------------------------------------------------------------------------------------------------------------------
docker-helm-yii_elasticsearch_1 /usr/local/bin/docker-entr ... Up 9200/tcp, 9300/tcp
docker-helm-yii_filebeat_1 /usr/local/bin/docker-entr ... Up
docker-helm-yii_fpm_1 docker-entrypoint fpm Up (healthy) 9000/tcp
docker-helm-yii_kibana_1 /usr/local/bin/dumb-init - ... Up 0.0.0.0:5601->5601/tcp
docker-helm-yii_mailhog_1 MailHog Up 1025/tcp, 0.0.0.0:8025->8025/tcp
docker-helm-yii_mysql_1 docker-entrypoint.sh --def ... Up 3306/tcp, 33060/tcp
docker-helm-yii_nginx_1 docker-entrypoint nginx -g ... Up (healthy) 0.0.0.0:80->80/tcp
docker-helm-yii_rabbitmq_1 docker-entrypoint.sh rabbi ... Up 15671/tcp, 0.0.0.0:15672->15672/tcp, 25672/tcp, 4369/tcp, 5671/tcp, 5672/tcp
docker-helm-yii_setup_1 docker-entrypoint setup Exit 0
docker-helm-yii_supervisor_1 docker-entrypoint supervisor Up (healthy) 0.0.0.0:9000->9000/tcp
```

If you want to change a PHP or Nginx version, open `docker-compose.yaml` and add build args:

+ `PHP_VERSION` for change php version (ex: `PHP_VERSION: '7.3'`).
+ `NGINX_VERSION` for change nginx version (ex: `NGINX_VERSION: '1.16'`).

Open [Dockerfile](/docker/Dockerfile) to see more build args.

Now you can visiting:

+ Your Yii app: http://localhost
+ Supervisor: http://localhost:9000 (Username: `root`, Password: `root` you can set it in `docker-compose.override.yaml`)
+ RabbitMQ: http://localhost:15672 (Username: `guest`, Password: `guest` you can set it in `docker-compose.override.yaml`)
+ Kibana: http://localhost:5601
+ Mailhog: http://localhost:8025

And access MySQL via port 3306 (Username: `root`, Password: `root` you can set it in `docker-compose.override.yaml`)

## Deploy project into Kubernetes cluster

### Install

Firstly you need to update helm dependencies by running:

```shell script
$ helm dep update ./helm/yii
```

And install chart:

```shell script
$ helm install app ./helm/yii
```

The command deploys your project on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.

### Uninstalling the Chart

To uninstall/delete the app deployment:

```shell script
$ helm uninstall app
```

### Parameters

The following table lists the configurable parameters of this chart and their default values.

| Parameter
|---------------------
| imagePullSecrets
| imagePullPolicy
| php.image.repository
| php.image.tag
| php.supervisor.basicAuth.username
| php.supervisor.basicAuth.password
| php.supervisor.replicaCount
| php.supervisor.nodeSelector
| php.supervisor.tolerations
| php.supervisor.affinity
| php.supervisor.podAnnotations
| php.supervisor.resources
| php.fpm.replicaCount
| php.fpm.nodeSelector
| php.fpm.tolerations
| php.fpm.affinity
| php.fpm.podAnnotations
| php.fpm.resources
| php.env
| php.debug
| php.trustedProxies
| nginx.image.repository
| nginx.image.tag
| nginx.replicaCount
| nginx.nodeSelector
| nginx.tolerations
| nginx.affinity
| nginx.podAnnotations
| nginx.resources
| ingress.annotations
| ingress.tls
| ingress.nginx.host
| ingress.nginx.tlsSecret
| ingress.supervisor.host
| ingress.supervisor.tlsSecret
| mysql.internal
| mysql.fullnameOverride
| mysql.mysqlDatabase
| mysql.mysqlUser
| mysql.mysqlPassword
| mysql.persistence.enabled
| mysql.nodeSelector
| mysql.tolerations
| mysql.podAnnotations
| mysql.resources
| mysql.externalDatabase
| mysql.externalHost
| mysql.externalPort
| mysql.externalUser
| mysql.externalPassword
| rabbitmq.internal
| rabbitmq.fullnameOverride
| rabbitmq.updateStrategy.type
| rabbitmq.persistence.enabled
| rabbitmq.service.port
| rabbitmq.rabbitmq.username
| rabbitmq.rabbitmq.password
| rabbitmq.ingress.enabled
| rabbitmq.ingress.tls
| rabbitmq.ingress.tlsSecret
| rabbitmq.ingress.hostName
| rabbitmq.ingress.annotations
| rabbitmq.nodeSelector
| rabbitmq.tolerations
| rabbitmq.affinity
| rabbitmq.podAnnotations
| rabbitmq.resources
| rabbitmq.externalHost
| rabbitmq.externalPort
| rabbitmq.externalUser
| rabbitmq.externalPassword | Description | Default | -------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| | Docker registry secret names as an array. | `[]` | | Image pull policy. | `Always` | | PHP image name. | `vuongxuongminh/docker-helm-yii-php` | | PHP image tag. | `prod` | | Supervisor basic auth username. | `user` | | Supervisor basic auth password. | `!ChangeMe!` | | Supervisor replica count. | `1` | | Supervisor node labels for pod assignment. | `{}` | | Supervisor toleration labels for pod assignment. | `[]` | | Supervisor affinity settings for pod assignment. | `{}` | | Supervisor pod annotations. | `{}` | | Supervisor resource needs and limits to apply to the pod. | `{}` | | FPM replica count. | `1` | | FPM node labels for pod assignment. | `{}` | | FPM toleration labels for pod assignment. | `[]` | | FPM affinity settings for pod assignment. | `{}` | | FPM pod annotations. | `{}` | | FPM resource needs and limits to apply to the pod. | `{}` | | Use to set `APP_ENV` env in Supervisor & FPM containers. | `production` | | Use to set `APP_DEBUG` env in Supervisor & FPM containers. | `false` | | | Use to set `TRUSTED_PROXIES` env in Supervisor & FPM containers. | `[10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16]` list common CIDR default of K8S. | | Nginx image name. | `vuongxuongminh/docker-helm-yii-nginx` | | Nginx image tag. | `prod` | | Nginx replica count. | `1` | | Nginx node labels for pod assignment. | `{}` | | Nginx toleration labels for pod assignment. | `[]` | | Nginx affinity settings for pod assignment. | `{}` | | Nginx pod annotations. | `{}` | | Nginx resource needs and limits to apply to the pod. | `{}` | | Ingress annotations. | `{}` | | Enable ingress with tls. | `false` | | Ingress Nginx host name. | `nginx.example` | | Ingress Nginx tls secret name. | `nginx-tls` | | Ingress Supervisor host name. | `supervisor.example` | | Ingress Supervisor tls secret name. | `supervisor-tls` | | Use internal MySQL (sub chart) or not. | `true` | | MySQL internal fullname. | `sub-chart-mysql` | | MySQL internal database name. | `test` | | MySQL internal username. | `user` | | MySQL internal password. | `!ChangeMe!` | | MySQL internal use a PVC to persist data. | `false` | | MySQL internal node labels for pod assignment. | `{}` | | MySQL internal toleration labels for pod assignment. | `[]` | | MySQL internal pod annotations. | `{}` | | MySQL internal resource needs and limits to apply to the pod. | `{}` | | MySQL externalDatabase use to set `DB_DATABASE` env in Supervisor & FPM containers. Use when `mysql.internal` is false. | `''` | | MySQL externalHost use to set `DB_HOST` env in Supervisor & FPM containers. Use when `mysql.internal` is false. | `''` | | MySQL externalPort use to set `DB_PORT` env in Supervisor & FPM containers. Use when `mysql.internal` is false. | `3306` | | MySQL externalUser use to set `DB_USERNAME` env in Supervisor & FPM containers. Use when `mysql.internal` is false. | `''` | | MySQL externalPassword use to set `DB_PASSWORD` env in Supervisor & FPM containers. Use when `mysql.internal` is false. | `''` | | Use internal RabbitMQ (sub chart) or not. | `true` | | RabbitMQ internal fullname. | `sub-chart-rabbitmq` | | RabbitMQ internal statefulset update strategy policy. | `OnDelete` | | RabbitMQ internal use a PVC to persist data. | `false` | | RabbitMQ internal service port. | `5672` | | RabbitMQ internal username. | `user` | | RabbitMQ internal password. | `!ChangeMe!` | | RabbitMQ internal enable ingress for management site or not. | `true` | | RabbitMQ internal enable ingress with tls. | `false` | | RabbitMQ internal ingress tls secret name. | `rabbitmq-tls` | | RabbitMQ internal ingress host name. | `rabbitmq.example` | | RabbitMQ internal ingress annotations. | `{}` | | RabbitMQ internal node labels for pod assignment. | `{}` | | RabbitMQ internal toleration labels for pod assignment. | `[]` | | RabbitMQ internal affinity settings for pod assignment. | `{}` | | RabbitMQ internal pod annotations. | `{}` | | RabbitMQ internal resource needs and limits to apply to the pod. | `{}` | | RabbitMQ externalHost use to set `RABBITMQ_HOST` env in Supervisor & FPM containers. Use when `rabbitmq.internal` is false. | `''` | | RabbitMQ externalPort use to set `RABBITMQ_PORT` env in Supervisor & FPM containers. Use when `rabbitmq.internal` is false. | `5672` | | RabbitMQ externalUser use to set `RABBITMQ_USER` env in Supervisor & FPM containers. Use when `rabbitmq.internal` is false. | `''` | | RabbitMQ externalPassword use to set `RABBITMQ_PASSWORD` env in Supervisor & FPM containers. Use when `rabbitmq.internal` is false. | `''` |

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

```shell script
$ helm install app ./helm/yii \
--set ingress.nginx.hostName=nginx.example.com,ingress.supervisor.hostName=supervisor.example.com,rabbitmq.ingress.hostName=rabbitmq.example.com
```

The above command sets the Nginx host name to `nginx.example.com`, Supervisor host name to `supervisor.example.com` and RabbitMQ management host name to `rabbitmq.example.com`.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

```shell script
$ helm install app ./helm/yii -f values.yaml
```

> Tip: You can use the default [values.yaml](/helm/yii/values.yaml)

### About database migration job

When you install or upgrade chart, Helm automatically invoke [database migration job](/helm/yii/templates/hook/job.yaml) after it done thanks to [chart hook](https://helm.sh/docs/topics/charts_hooks/).

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/vuongxuongminh/docker-helm-yii

Awesome Lists containing this project

README