Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add plane template #501

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add plane template #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
271766d
Add plane template
marktopper Mar 10, 2024
2ecaedb
Update schema and domains (using EASYPANEL_HOST for domains now)
marktopper Mar 21, 2024
4c7cac0
Allow setting random password length
marktopper Mar 21, 2024
7ad680b
Merge branch 'main' into feature/add-makeplane
serban-alexandru Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added templates/plane/assets/logo.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added templates/plane/assets/screenshot.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
312 changes: 312 additions & 0 deletions templates/plane/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,312 @@
import { Output, randomPassword, Services } from '~templates-utils';
import { Input } from './meta';

export function generate(input: Input): Output {
const services: Services = [];

const redisPassword = input.redisPassword ?? randomPassword();
const postgresPassword = input.postgresPassword ?? randomPassword();

const planeVersion = input.planeVersion;

const projectDomainPrefix = input.projectName;
const mainDomain = input.mainDomain ?? projectDomainPrefix + '.$(EASYPANEL_HOST)';
const minioConsoleDomain = input.minioConsoleDomain ?? 'minio-console-' + projectDomainPrefix + '.$(EASYPANEL_HOST)';
const minioApiDomain = input.minioApiDomain ?? 'minio-api-' + projectDomainPrefix + '.$(EASYPANEL_HOST)';

const minioRootUser = input.minioRootUser ?? 'root';
const minioRootPass = input.minioRootPass ?? randomPassword();

const sentryDsn = input.sentryDsn ?? '';
const sentryEnvironment = input.sentryEnvironment ?? 'production';

const instanceKey = input.instanceKey ?? randomPassword(64);
const secretKey = input.secretKey ?? randomPassword(64);

const backendEnvironments = [
'# All the available environments can be found going through https://github.com/makeplane/plane/tree/v0.16-dev/apiserver/plane/settings',
'',
'INSTANCE_KEY="' + instanceKey + '"',
'SECRET_KEY="' + secretKey + '"',
'',
'DEBUG=0',
'',
'SENTRY_DSN="' + sentryDsn + '"',
'SENTRY_ENVIRONMENT="' + sentryEnvironment + '"',
'',
'DATABASE_URL="postgres://postgres:' + postgresPassword + '@' + input.projectName + '_db:5432/' + input.projectName + '"',
'REDIS_URL="redis://default:' + redisPassword + '@' + input.projectName + '_redis:6379/"',
'',
'AWS_REGION=""',
'AWS_ACCESS_KEY_ID="' + minioRootUser + '"',
'AWS_SECRET_ACCESS_KEY="' + minioRootPass + '"',
'AWS_S3_ENDPOINT_URL="https://' + minioApiDomain + '"',
'AWS_S3_BUCKET_NAME="uploads"',
'FILE_SIZE_LIMIT=5242880',
'USE_MINIO=1',
'',
'WEB_URL="https://' + mainDomain + '"',
'',
'GUNICORN_WORKERS=2',
].join("\n");

const minioEnvironments = [
'MINIO_ROOT_USER="' + minioRootUser + '"',
'MINIO_ROOT_PASSWORD="' + minioRootPass + '"',
].join("\n");

const proxyEnvironment = [
'FILE_SIZE_LIMIT=5242880',
'BUCKET_NAME=uploads',
'',
'DOMAIN_NAME=' + mainDomain,
'',
'FRONTEND_HOST=http://' + input.projectName + '_web:3000/',
'API_HOST=http://' + input.projectName + '_api:8000/api/',
'SPACE_HOST=http://' + input.projectName + '_space/spaces/',
'MINIO_HOST=http://' + input.projectName + '_minio:9000/uploads/',
].join("\n");

const nginxConf = [
'events {',
'}',
'',
'http {',
' sendfile on;',
' server {',
' listen 80;',
' root /www/data/;',
'',
' access_log /var/log/nginx/access.log;',
' client_max_body_size ${FILE_SIZE_LIMIT};',
'',
' add_header X-Content-Type-Options "nosniff" always;',
' add_header Referrer-Policy "no-referrer-when-downgrade" always;',
' add_header Permissions-Policy "interest-cohort=()" always;',
' add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;',
'',
' location / {',
' proxy_pass ${FRONTEND_HOST};',
' }',
'',
' location /api/ {',
' proxy_pass ${API_HOST};',
' proxy_set_header Host \'${DOMAIN_NAME}\';',
' }',
'',
' location /spaces/ {',
' rewrite ^/spaces/?$ /spaces/login break;',
' proxy_pass ${SPACE_HOST};',
' }',
'',
' location /${BUCKET_NAME}/ {',
' proxy_pass ${MINIO_HOST};',
' proxy_set_header Host \'${DOMAIN_NAME}\';',
' }',
' }',
'}',
].join("\n");

const proxyEntrypoint = [
'#!/bin/sh',
'',
'export dollar="$"',
'export http_upgrade="http_upgrade"',
'envsubst < /etc/nginx/nginx.conf.custom > /etc/nginx/nginx.conf',
"exec nginx -g 'daemon off;'",
].join("\n");

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'api',
'source': {
'type': 'image',
'image': 'makeplane/plane-backend:' + planeVersion
},
'env': backendEnvironments,
'deploy': {
'replicas': 1,
'command': [
'python manage.py wait_for_db',
'python manage.py migrate',
'./bin/takeoff'
].join(' && '),
'zeroDowntime': true
}
}
});

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'beat-worker',
'source': {
'type': 'image',
'image': 'makeplane/plane-backend:' + planeVersion
},
'env': backendEnvironments,
'deploy': {
'replicas': 1,
'command': './bin/beat',
'zeroDowntime': true
}
}
});

services.push({
'type': 'postgres',
'data': {
'projectName': input.projectName,
'serviceName': 'db',
'image': 'postgres:16',
'password': postgresPassword
}
});

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'minio',
'source': {
'type': 'image',
'image': 'minio/minio'
},
'env': minioEnvironments,
'deploy': {
'replicas': 1,
'command': 'minio server /export --console-address ":9090"',
'zeroDowntime': true
},
'domains': [
{
'host': minioApiDomain,
'https': true,
'port': 9000,
'path': '/',
'middlewares': []
},
{
'host': minioConsoleDomain,
'https': true,
'port': 9090,
'path': '/',
'middlewares': []
}
],
'mounts': [
{
'type': 'volume',
'name': 'uploads',
'mountPath': '/export'
}
]
}
});

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'proxy',
'source': {
'type': 'image',
'image': 'makeplane/plane-proxy:' + planeVersion
},
'env': proxyEnvironment,
'deploy': {
'replicas': 1,
'command': 'sh /custom-docker-entrypoint.sh',
'zeroDowntime': true
},
'domains': [
{
'host': mainDomain,
'https': true,
'port': 80,
'path': '/',
'middlewares': []
}
],
'mounts': [
{
'type': 'file',
'content': proxyEntrypoint,
'mountPath': '/custom-docker-entrypoint.sh'
},
{
'type': 'file',
'content': nginxConf,
'mountPath': '/etc/nginx/nginx.conf.custom'
}
]
}
});

services.push({
'type': 'redis',
'data': {
'projectName': input.projectName,
'serviceName': 'redis',
'image': 'redis:7',
'password': redisPassword
}
});

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'space',
'source': {
'type': 'image',
'image': 'makeplane/plane-space:' + planeVersion
},
'deploy': {
'replicas': 1,
'command': '/usr/local/bin/start.sh space/server.js space',
'zeroDowntime': true
}
}
});

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'web',
'source': {
'type': 'image',
'image': 'makeplane/plane-frontend:' + planeVersion
},
'deploy': {
'replicas': 1,
'command': '/usr/local/bin/start.sh web/server.js web',
'zeroDowntime': true
}
}
});

services.push({
'type': 'app',
'data': {
'projectName': input.projectName,
'serviceName': 'worker',
'source': {
'type': 'image',
'image': 'makeplane/plane-backend:' + planeVersion
},
'env': backendEnvironments,
'deploy': {
'replicas': 1,
'command': './bin/worker',
'zeroDowntime': true
}
}
});

return { services };
}