Ibs
Django 5.2 + Vue3 + Svelte using Nginx + MariaDB or 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
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 docker-compose.yml file.
- required:
- POSTGRES_DB
- POSTGRES_USER
- POSTGRES_PASSWORD
- MYSQL_DATABASE
- MYSQL_USER
- MYSQL_PASSWORD
- MYSQL_ROOT_PASSWORD
- DATABASE_TYPE
- DATABASE_PORT
- DATABASE_NAME
- DATABASE_USER
- DATABASE_PASSWORD
- DOMAIN_NAME
- EMAIL_HOST
- EMAIL_PORT
- EMAIL_HOST_USER
- EMAIL_HOST_PASSWORD
- DEFAULT_FROM_EMAIL
- DJANGO_SETTINGS_MODULE
Enter the actual data for your environment as described in the following items.
postgres:
- POSTGRES_DB: my-db-name # postgresql 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
- MYSQL_ROOT_PASSWORD: my-db-root-password # mysql database information
- TZ: Asia/Seoul # mysql database information
web:
- DATABASE_TYPE: mariadb # mariadb | postgres, default = mariadb, db to use
- DATABASE_PORT: 3306 # 3306 | 5432, default = 3306, db port 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
- EMAIL_HOST_USER: your-access-id-or-email
- EMAIL_HOST_PASSWORD: your-access-password
- DEFAULT_FROM_EMAIL: your-email@example.com
- DJANGO_SETTINGS_MODULE: app.settings.prod # settings mode -> app.settings.prod or app.settings.local
4. Django setting
To develop in local mode set docker-compose.yml -> web -> DJANGO_SETTINGS_MODULE: app.settings.local
To develop in production mode, create a prod.py file with the following command:
cd app/django/app/settings
cp local.py prod.py
In production mode, configure the prod.py file according to your needs. If not modified, it is the same as local mode.
Build and run
docker-compose up -d --build
Migrations & Migrate settings (After build to db & web)
docker-compose exec web python manage.py makemigrations
docker-compose exec web python manage.py migrate
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 ..
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
Svelte (Single Page Application) Development
cd ..
cd app/svelte
pnpm i # npm i (or) yarn
Svelte application development -> node dev server on.
pnpm dev # npm run dev (or) yarn dev
or Svelte application deploy -> node build
pnpm build # npm run build (or) yarn build
Or Deploy Using Kubernetes
Requirement
- Kubernetes cluster
- 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 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 will be 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.
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)
- DEFAULT_FROM_EMAIL: # your-email@example.com
- EMAIL_HOST: # your-smtp-server.com
- EMAIL_HOST_PASSWORD: # your-access-password
- EMAIL_HOST_USER: # 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
- SLACK_INCOMING_URL: # slack incoming url
2. Deploy
Go to the action tab in the GitHub repository.
Click 'Show more workflows...' at the bottom of all workflows, click _initial [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 _initial [Prod Step2] at the bottom of all workflows in the action tab.
Reference
