Django 6.x + Vue3 using Nginx + PostgreSQL (deploy as Docker or Kubernetes)

Deploy Using Docker

Requirement in your system

• docker
• docker-compose
• node (with pnpm)

Usage

1. Clone this Repository

git clone https://github.com/nc2U/ibs
cd ibs/deploy

2. Copy docker-compose.yml

cd deploy
cp docker-compose.yml.tmpl docker-compose.yml

3. Write environments in docker-compose.yml

Check what must be defined in a docker-compose.yml file.

• required:

- POSTGRES_DB - POSTGRES_USER - POSTGRES_PASSWORD - MYSQL_DATABASE - MYSQL_USER - MYSQL_PASSWORD - MYSQLROOTPASSWORD - DATABASE_TYPE - DATABASE_NAME - DATABASE_USER - DATABASE_PASSWORD - DOMAIN_NAME - EMAIL_HOST - EMAIL_PORT - EMAILHOSTUSER - EMAILHOSTPASSWORD - DEFAULTFROMEMAIL - DJANGOSETTINGSMODULE

Enter the actual data for your environment as described in the following items. If you use a database image such as postgresql with Docker, be sure to use the default port.

• postgres:

- POSTGRES_DB: my-db-name # postgres database information - POSTGRES_USER: my-db-user # postgresql database information - POSTGRES_PASSWORD: my-db-password # postgresql database information

• master:

- MYSQL_DATABASE: my-db-name # mysql database information - MYSQL_USER: my-db-user # mysql database information - MYSQL_PASSWORD: my-db-password # mysql database information - MYSQLROOTPASSWORD: my-db-root-password # mysql database information - TZ: Asia/Seoul # mysql database information

• web:

- DATABASE_TYPE: postgres # postgres, default = postgres, db to use - DATABASE_NAME: my-db-name # mysql database information - DATABASE_USER: my-db-user # mysql database information - DATABASE_PASSWORD: my-db-password # mysql database information - DOMAIN_NAME: my-domain-name # https://my-domain.com/ - EMAIL_HOST: your-smtp-server.com - EMAIL_PORT: 588 # default is 587 - EMAILHOSTUSER: your-access-id-or-email - EMAILHOSTPASSWORD: your-access-password - DEFAULTFROMEMAIL: your-email@example.com - DJANGOSETTINGSMODULE: app.settings # django settings mode

4. Build & Run Docker Compose

Build and run

docker-compose up -d --build

5. Set environment

cd ../app/django
cp env .env vi .env # ... & Set each setting value as below. You should replace the value of each item with your own value.

### FOR DJANGO APP ----------------------------------------------------------------------------------
SECRETKEY='DuqJwGzWqVo2...'      # required, Set random characters of at least 50 characters.
DEBUG=                             # default=False
ALLOWED_HOSTS=                     # default=*, set the like this -> host1,host2,host3...
DATABASE_TYPE=                     # default=postgres, set the helm chart values.global.dbType DATABASEUSER=ibsuser             # required, This name is referenced when releasing helm. DATABASEPASSWORD=mysecret        # default='', set the helm chart values.global.dbPassword
DOMAIN_HOST=https://abc.com        # default=http://localhost/, set the helm chart values.global.domainHost DOMAIN_NAME=abc.com                # default=localhost, Representative domain when using multiple hosts via Ingress
EMAIL_HOST=my.email.com            # required, set the helm chart values.global.emailHost EMAILHOSTUSER=mail_user          # required, set the helm chart values.global.emailHostUser EMAILHOSTPASSWORD=my_secret      # required, set the helm chart values.global.emailHostPassword DEFAULTFROMEMAIL=admin@host.com  # required, set the helm chart values.global.defaultFromEmail
FOR DEPLOYMENT ------------------------------------------------------------------------------------
CICD_HOST=12.345.67.890            # required, nfs server for django app source & database data
CICDUSER=cicduser
CICDPASS=mypassword
CICD_PATH=/mnt/nfs/ibs             # path where set the django source
NFS_HOST=22.333.44.555             # required, nfs server for database backup files & django media files NFSUSER=nfsuser NFSPASS=nfspassword NFS_PATH=/mnt/nfs/ibs              # path where set the django media files & backup files

6. Migrate & Basic Settings

Migrations & Migrate settings (After build to db & web)

The commands below sequentially run the python manage.py makemigrations and python manage.py migrate commands.

cd ../../deploy
docker-compose exec web sh migrate.sh

Static file Setting

docker-compose exec web python manage.py collectstatic

※ Place your Django project in the django directory and develop it.

Vue (Single Page Application) Development

cd ../app/vue
pnpm i    # npm i (or) yarn

Vue application development -> node dev server on.

pnpm dev    # npm run dev (or) yarn dev

or Vue application deploy -> node build

pnpm build    # npm run build (or) yarn build

Or Deploy Using Kubernetes

Requirement

• Kubernetes cluster
• Helm
• CI/CD server with helm installed
• NFS Storage server(ip)
• domain(to deploy)
• GitHub account (for using GitHub Actions)
• Docker hub account
• Slack incoming url

Usage

1. Preparation

Kubernetes cluster

Configure a Kubernetes cluster by setting up the required number of nodes.

CI/CD server

The ci/cd server uses the master node of the Kubernetes cluster or a separate server or PC.

If you use the master node in the cluster as a ci/cd server, set up external access through ssh and install helm on the master node.

If you are using a server or PC outside the cluster, configure it to connect via ssh from outside, install, kubectl & helm, and then copy and configure the kubeconfig file to the user's home directory to access and control the master node.

Check the IP or domain that can access the ci/cd server.

NFS storage server

For the nfs storage server, it is recommended to prepare a separate server if a large amount of data is used in the future, but you can also use the cluster's master node or ci/cd server.

Install the necessary packages according to the operating system on the server to be used as a storage server, run it as an NFS server, and connect it to the Kubernetes cluster nodes.

Also, enable connection via ssh and check the accessible IP or domain.

Domain & DNS setting

Secure the domain to be used for this project and connect each cluster node to the domain.

installing the cert-manager Chart

Full installation instructions, including details on how to configure extra functionality in cert-manager, can be found in the installation docs.

Before installing the chart, you must first install the cert-manager CustomResourceDefinition resources. This is performed in a separate step to allow you to easily uninstall and reinstall cert-manager without deleting your installed custom resources. (Please use version 17., as version 18. has compatibility issues with the current version of ingress-nginx Release.)

$ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.4/cert-manager.crds.yaml

To install the chart with the release name cert-manager:

## Add the Jetstack Helm repository
$ helm repo add jetstack https://charts.jetstack.io --force-update
Install the cert-manager helm chart
$ helm install cert-manager --namespace cert-manager --version v1.17.4 jetstack/cert-manager --create-namespace

installing the ingress-nginx Chart

Get repo info

helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm repo update

install Chart

helm install ingress-nginx -n ingress-nginx ingress-nginx/ingress-nginx --create-namespace

2. Deploy

Deploy using GitHub action (Full auto)

GitHub & DockerHub account, Slack incoming url

Use an existing GitHub account or create a new one and fork this project.

Afterward, go to the Settings > Secrets and variables > Actions menu and click the 'New repository secret' button to create Repository secrets with the keys and values below.

• CICD_HOST: # cicd server host(ip or domain)
• CICD_PASS: # cicd server user password
• CICD_PATH: # cicd helm chart & volume path
• CICD_USER: # cicd server user
• DATABASE_PASS: # root & db user password
• DATABASE_USER: # db & db user name
• DOCKERHUB_TOKEN: # docker hub user password (If you manage your images in your own Docker hub)
• DOCKERHUB_USER: # docker hub user id (If you manage your images in your own Docker hub)
• DOMAIN_HOST: # full address (https://abc.com/ for getting url)
• DOMAIN_NANE: # domain address (for ingress)
• DEFAULTFROMEMAIL: # your-email@example.com
• EMAIL_HOST: # your-smtp-server.com
• EMAILHOSTPASSWORD: # your-access-password
• EMAILHOSTUSER: # your-access-id-or-email
• NFS_HOST: # nfs storage server host(ip or domain)
• NFS_PASS: # nfs storage server user password
• NFS_PATH: # nfs storage server path (absolute path)
• NFS_USER: # nfs storage server user
• SLACKINCOMINGURL: # slack incoming url

How to Deploy

And then, Go to the Actions tab in the GitHub repository.

Click 'Show more workflows...' at the bottom of all workflows, click initSetup [Prod Step1], and then use the Kubernetes watch command on the cicd server to check whether the relevant PODs are created and operating normally.

When all database pods operate normally, Click initSetup [Prod Step2] at the bottom of all workflows in the Actions tab.

Or Manually Deploy

NFS server setting

ssh nfsuser@nfsserver
mkdir -p /mnt/nfs/ibs  # your NFS_PATH
cd /mnt/nfs/ibs  # your NFS_PATH mkdir -p ./prod/app/django/media && chmod -R 775 ./app/django

CICD server setting

ssh cicduser@cicdserver
mkdir -p /mnt/nfs/ibs  # your CICD_HOST
cd /mnt/nfs/ibs  # your CICD_HOST
mkdir ./prod && cd prod git clone https://github.com/nc2u/ibs .   # or forked your project
rm -rf .git .md app/vue deploy/docker .docker-compose.yml && \ mkdir -p ./app/repos
cd app/django cp env .env vi .env # ... & Set each setting value as below. You should replace the value of each item with your own value.

<pre><code class="lang-dotenv">### FOR DJANGO APP ---------------------------------------------------------------------------------- SECRETKEY=&#39;DuqJwGzWqVo2...&#39; # required, Set random characters of at least 50 characters. DEBUG= # default=False ALLOWED_HOSTS= # default=*, set the like this -&gt; host1,host2,host3...

DATABASE_TYPE= # default=postgres, set the helm chart values.global.dbType DATABASEUSER=ibsuser # required, This name is referenced when releasing helm. DATABASEPASSWORD=mysecret # default=&#39;&#39;, set the helm chart values.global.dbPassword

DOMAIN_HOST=https://abc.com # default=http://localhost/, set the helm chart values.global.domainHost DOMAIN_NAME=abc.com # default=localhost, Representative domain when using multiple hosts via Ingress

EMAIL_HOST=my.email.com # required, set the helm chart values.global.emailHost EMAILHOSTUSER=mail_user # required, set the helm chart values.global.emailHostUser EMAILHOSTPASSWORD=my_secret # required, set the helm chart values.global.emailHostPassword DEFAULTFROMEMAIL=admin@host.com # required, set the helm chart values.global.defaultFromEmail

FOR DEPLOYMENT ------------------------------------------------------------------------------------

CICD_HOST=12.345.67.890 # required, nfs server for django app source &amp; database data CICDUSER=cicduser CICDPASS=mypassword CICD_PATH=/mnt/nfs/ibs # path where set the django source

NFS_HOST=22.333.44.555 # required, nfs server for database backup files &amp; django media files NFSUSER=nfsuser NFSPASS=nfspassword NFS_PATH=/mnt/nfs/ibs # path where set the django media files &amp; backup files</code></pre>

<pre><code class="lang-bash">:wq cd ../../deploy/helm</code></pre>

Deploy way 1

If you know the rules of helm chart and how to set values in values.yaml, choose this method.

<pre><code class="lang-bash">cp values-prod.yaml values-prod-custom.yaml vi values-prod-custom.yaml # set the your value :wq

sh prod-deploy.sh</code></pre>

Or Deploy way 2

If you don't know how to set up a helm chart, that's okay. Since you've already set up the .env file, you can use those values to deploy your helm chart.

<pre><code class="lang-bash">ENV_PATH=&quot;../../app/django/.env&quot;

while IFS=&#39;=&#39; read -r key value || [ -n &quot;$key&quot; ]; do case &quot;$key&quot; in &#39;&#39;|\#*) ;; # Ignore blank lines or comments *) # Remove quotes and export clean_key=&quot;$(echo &quot;$key&quot; | sed -e &#39;s/^\s//&#39; -e &#39;s/\s$//&#39;)&quot; clean_value=$(echo &quot;$value&quot; | sed -e &#39;s/^\\s[\&quot;\\&#39;\\&#39;]//&#39; -e &#39;s/[\&quot;\\&#39;\\&#39;]\\s$//&#39;) export &quot;$cleankey=$cleanvalue&quot; ;; esac done &lt; &quot;$ENV_PATH&quot;

if ! helm repo list | grep -q &#39;nfs-subdir-external-provisioner&#39;; then helm repo add nfs-subdir-external-provisioner https://kubernetes-sigs.github.io/nfs-subdir-external-provisioner fi if ! helm status nfs-subdir-external-provisioner -n kube-system &gt;/dev/null 2&gt;&amp;1; then helm upgrade --install nfs-subdir-external-provisioner \ nfs-subdir-external-provisioner/nfs-subdir-external-provisioner \ -n kube-system \ --set nfs.server=${CICD_HOST} \ --set nfs.path=/mnt/nfs-subdir-external-provisioner fi

kubectl apply -f ../kubectl/class-roles;

helm upgrade ${DATABASE_USER} . -f ./values-prod.yaml \ --install -n ibs-prod --create-namespace --history-max 5 --wait --timeout 10m \ --set global.dbPassword=${DATABASE_PASSWORD} \ --set global.cicdServerHost=${CICD_HOST} \ --set global.cicdPath=${$CICD_PATH} \ --set global.nfsServerHost=${NFS_HOST} \ --set global.nfsPath=${NFS_PATH} \ --set global.domainHost=${DOMAIN_HOST} \ --set global.emailHost=${EMAIL_HOST} \ --set global.emailHostUser=${EMAILHOSTUSER} \ --set-string global.emailHostPassword=&quot;${EMAILHOSTPASSWORD}&quot; \ --set global.defaultFromEmail=&quot;${DEFAULTFROMEMAIL}&quot; \ --set postgres.auth.postgresPassword=${DATABASE_PASSWORD} \ --set postgres.auth.password=${DATABASE_PASSWORD} \ --set postgres.auth.replicationPassword=${DATABASE_PASSWORD} \ --set &#39;nginx.ingress.hosts[0].host&#39;=${DOMAIN_NAME} \ --set &#39;nginx.ingress.hosts[0].paths[0].path&#39;=/ \ --set &#39;nginx.ingress.hosts[0].paths[0].pathType&#39;=Prefix \ --set &#39;nginx.ingress.tls[0].hosts[0]&#39;=${DOMAIN_NAME} \ --set &#39;nginx.ingress.tls[0].secretName&#39;=web-devbox-kr-cert</code></pre>

3. if you deploy the release manually: Migrate & Basic Settings

If all pods are running normally, run the following procedure. The commands below sequentially run the python manage.py makemigrations and python manage.py migrate` commands.

kubectl exec -it {web-pod} sh migrate.sh  # Replace {web-pod} with the actual pod name.

Static file Setting

kubectl exec -it {web-pod} python manage.py collectstatic  # Replace {web-pod} with the actual pod name.

※ Place your Django project in the django directory and develop it.

Vue (Single Page Application) Development

cd ..
cd app/vue3
pnpm i    # npm i (or) yarn

Vue application development -> node dev server on.

pnpm dev    # npm run dev (or) yarn dev

or Vue application deploy -> node build

pnpm build    # npm run build (or) yarn build

Reference

• Python
• Docker
• Docker compose
• Kubernetes
• Helm
• Nginx
• PostgreSQL
• Django
• Django Rest Framework
• Node
• Pnpm