Skip to content

Latest commit

 

History

History
267 lines (238 loc) · 11.5 KB

DEPLOY.md

File metadata and controls

267 lines (238 loc) · 11.5 KB
Raw

Déploiement

Préliminaire

Pour pouvoir déployer l'application, vous devez à minima vous munir de :

  • des clés pour Firebase, voir le README général à ce sujet.
  • d'un bucket S3, de type Google Cloud Storage (avec compatibilité S3), Amazon S3 ou MinIO (open-source) pour le stockage des médias.
  • d'un fournisseur de mails, de type Mailgun ou Brevo pour l'envoi des mails.

Deux solutions sont proposées pour le déploiement de l'application :

  1. Premièrement un déploiement sur un cluster Kubernetes en utilisant le chart helm fourni
  2. Deuxièmement un déploiement sur une machine virtuelle (type VPS) en utilisant Docker

Sur kubernetes en utilisant le chart helm

Vous devez disposer sur votre machine de Docker desktop ou Docker server (à privilégier sous GNU/Linux).

Vous devez aussi disposer d'un cluster Kubernetes où déployer la release helm. Il est pré-supposé que vous êtes déjà positionné·e sur le cluster et le namespace où vous souhaitez déployer l'application.

La première étape consiste à cloner le dépôt Git :

git clone https://github.com/coopTilleuls/bikelib.git

Puis à vous positionner sur le dernier tag (release) au moyen de la commande suivante :

export LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
git switch -d $LATEST_TAG

Build des images

Ensuite, créer un fichier .env qui contiendra les variables de build pour la PWA :

# PWA build-args
NEXT_PUBLIC_CF_TURNSTILE_SITE_KEY=!A_Changer!
NEXT_PUBLIC_FIREBASE_API_KEY=!A_Changer!
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=!A_Changer!
NEXT_PUBLIC_FIREBASE_PROJECT_ID=!A_Changer!
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=!A_Changer!
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=!A_Changer!
NEXT_PUBLIC_FIREBASE_APP_ID=!A_Changer!
NEXT_PUBLIC_VAPID_KEY=!A_Changer!

À partir de là, lancer le build des images :

docker compose -f docker-compose.yml -f docker-compose.prod.yml build

Ne pas se soucier des messages quant au fait que des variables sont manquantes. Elles ne sont pas nécessaires au build des images.

Push des images

Maintenant que les images sont build, il est nécessaire de les tagguer et de les envoyer sur un registre Docker/OCI de votre choix.

Par exemple pour Docker Hub :

# bikelib-php (API)
docker tag bikelib-php hub.docker.com/monutilisateur/monnamespace/bikelib-php:${LATEST_TAG}
docker push hub.docker.com/monutilisateur/monnamespace/bikelib-php:${LATEST_TAG}
# bikelib-caddy (API)
docker tag bikelib-caddy hub.docker.com/monutilisateur/monnamespace/bikelib-caddy:${LATEST_TAG}
docker push hub.docker.com/monutilisateur/monnamespace/bikelib-caddy:${LATEST_TAG}
# bikelib-pwa (PWA)
docker tag bikelib-pwa hub.docker.com/monutilisateur/monnamespace/bikelib-pwa:${LATEST_TAG}
docker push hub.docker.com/monutilisateur/monnamespace/bikelib-pwa:${LATEST_TAG}

Déploiement

export APP_URL=bikelib.mondomaine.com # À modifier
export REGISTRY_URL=hub.docker.com/monutilisateur/monnamespace # À modifier
export STORAGE_BUCKET=A_MODIFIER # À modifier
export STORAGE_ENDPOINT=A_MODIFIER # À modifier
export STORAGE_REGION=A_MODIFIER # À modifier
export STORAGE_KEY=A_MODIFIER # À modifier
export STORAGE_SECRET=A_MODIFIER # À modifier
export FIREBASE_PROJECT_ID=A_MODIFIER # À modifier
export FIREBASE_PRIVATE_KEY_ID=A_MODIFIER # À modifier
export FIREBASE_PRIVATE_KEY=A_MODIFIER # À modifier
export FIREBASE_CLIENT_EMAIL=A_MODIFIER # À modifier
export FIREBASE_CLIENT_ID=A_MODIFIER # À modifier
export FIREBASE_AUTH_URI=A_MODIFIER # À modifier
export FIREBASE_TOKEN_URI=A_MODIFIER # À modifier
export FIREBASE_AUTH_PROVIDER=A_MODIFIER # À modifier
export FIREBASE_CLIENT_CERT_URL=A_MODIFIER # À modifier
export FIREBASE_UNIVERSE_DOMAIN=A_MODIFIER # À modifier
export MAILER_SENDER=bikelib@${APP_URL} # À modifier
export MAILER_DSN=mailgun+api://DOMAIN_API_KEY:DOMAIN@default?region=eu # À modifier
export APP_APP_JWT_PUBLIC_KEY=$(openssl rand -base64 32)
export APP_JWT_PASSPHRASE=$(openssl rand -base64 32)
export APP_JWT_SECRET_KEY=$(openssl genpkey -pass file:<(echo "$APP_APP_JWT_PUBLIC_KEY") -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096)
export APP_JWT_PUBLIC_KEY=$(openssl pkey -in <(echo "$APP_JWT_SECRET_KEY") -passin file:<(echo "$APP_APP_JWT_PUBLIC_KEY") -pubout)
export TRUSTED_HOSTS="^127.0.0.1|localhost|${APP_URL}|bikelib$"
export MERCURE_JWT_PUBLIC_KEY=$(openssl genpkey -pass file:<(echo "$APP_JWT_PASSPHRASE") -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096)
export MERCURE_EXTRA_DIRECTIVES=$(cat <<EOF
cors_origins http://localhost:8080 http://localhost:8081 https://localhost http://localhost https://${APP_URL}
EOF
)
helm upgrade --install bikelib ./helm/chart \
--atomic \
--debug \
--set=php.image.repository="${REGISTRY_URL}/bikelib-php" \
--set=php.image.tag="${LATEST_TAG}" \
--set=caddy.image.repository="${REGISTRY_URL}/bikelib-caddy" \
--set=caddy.image.tag="${LATEST_TAG}" \
--set=pwa.image.repository="${REGISTRY_URL}/bikelib-pwa" \
--set=pwa.image.tag="${LATEST_TAG}" \
--set=ingress.hosts[0].host=${APP_URL} \
--set=ingress.tls[0].secretName=bikelib-tls \
--set=ingress.tls[0].hosts[0]=${APP_URL} \
--set=php.corsAllowOrigin="https?://.*?\.${APP_URL}$" \
--set=mailer.dsn='${MAILER_DSN}' \
--set=php.corsAllowOrigin="https?://${APP_URL}$" \
--set=php.trustedHosts="${TRUSTED_HOSTS//./\\\\.}" \
--set=php.jwt.secretKey="${APP_JWT_SECRET_KEY}" \
--set=php.jwt.publicKey="${APP_JWT_PUBLIC_KEY}" \
--set=php.jwt.passphrase=${APP_APP_JWT_PUBLIC_KEY} \
--set=php.host=${APP_URL} \
--set=mercure.publicUrl=https://${APP_URL}/.well-known/mercure \
--set=mercure.jwtSecret="${MERCURE_JWT_PUBLIC_KEY}" \
--set=mercure.extraDirectives="${MERCURE_EXTRA_DIRECTIVES}" \
--set=php.storage.bucket="${STORAGE_BUCKET}" \
--set=php.storage.endpoint="${STORAGE_ENDPOINT}" \
--set=php.storage.region="${STORAGE_REGION}" \
--set=php.storage.usePathStyleEndpoint=true \
--set=php.storage.key="${STORAGE_KEY}" \
--set=php.storage.secret="${STORAGE_SECRET}" \
--set=php.firebase.projectID="${FIREBASE_PROJECT_ID}" \
--set=php.firebase.privateKeyID="${FIREBASE_PRIVATE_KEY_ID}" \
--set=php.firebase.privateKey="$(echo $FIREBASE_PRIVATE_KEY | base64)" \
--set=php.firebase.clientEmail="${FIREBASE_CLIENT_EMAIL}" \
--set=php.firebase.clientID="${FIREBASE_CLIENT_ID}" \
--set=php.firebase.authUri="${FIREBASE_AUTH_URI}" \
--set=php.firebase.tokenUri="${FIREBASE_TOKEN_URI}" \
--set=php.firebase.authProvider="${FIREBASE_AUTH_PROVIDER}" \
--set=php.firebase.clientCertUrl="${FIREBASE_CLIENT_CERT_URL}" \
--set=php.firebase.universeDomain="${FIREBASE_UNIVERSE_DOMAIN}" \
--values ./helm/chart/values.yml \
--values ./helm/chart/values-prod.yml

Sur une machine virtuelle en utilisant Docker

Vous devez disposer d'une machine virtuelle où vous aurez au préalable installé Docker server. Théoriquement le déploiement devrait fonctionner également avec Docker desktop pour Linux, mais ce scénario n'a pas été testé.

La première étape consiste à cloner le dépôt Git :

git clone https://github.com/coopTilleuls/bikelib.git

Puis à vous positionner sur le dernier tag (release) au moyen de la commande suivante :

git switch -d $(git describe --tags `git rev-list --tags --max-count=1`)

Création des fichies variables

Vous allez devoir définir quelques variables qui seront ensuite utilisées pour générer le fichier de variables d'environnement

export APP_URL=bikelib.mondomaine.com # À modifier
export APP_APP_JWT_PUBLIC_KEY=$(openssl rand -base64 32)
export APP_JWT_PASSPHRASE=$(openssl rand -base64 32)
export APP_JWT_SECRET_KEY=$(openssl genpkey -pass file:<(echo "$APP_APP_JWT_PUBLIC_KEY") -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096)
export APP_JWT_PUBLIC_KEY=$(openssl pkey -in <(echo "$APP_JWT_SECRET_KEY") -passin file:<(echo "$APP_APP_JWT_PUBLIC_KEY") -pubout)
export MERCURE_JWT_PUBLIC_KEY=$(openssl genpkey -pass file:<(echo "$APP_JWT_PASSPHRASE") -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096)
export MERCURE_EXTRA_DIRECTIVES=$(cat <<EOF
cors_origins http://localhost:8080 http://localhost:8081 https://localhost http://localhost https://${APP_URL}
EOF
)
export APP_SECRET=$(openssl rand -base64 21)
export POSTGRES_PASSWORD=$(pwgen -s 25 1)
# Mercure keys
ssh-keygen -t rsa -b 4096 -m PEM -f publisher.key
openssl rsa -in publisher.key -pubout -outform PEM -out publisher.key.pub
ssh-keygen -t rsa -b 4096 -m PEM -f subscriber.key
openssl rsa -in subscriber.key -pubout -outform PEM -out subscriber.key.pub

Exécutez la commande suivante pour générer les clés nécessaires et les ajouter à un fichier .env :

tee -a .env <<EOF
# PWA build args
NEXT_PUBLIC_CF_TURNSTILE_SITE_KEY=!A_Changer!
NEXT_PUBLIC_FIREBASE_API_KEY=!A_Changer!
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=!A_Changer!
NEXT_PUBLIC_FIREBASE_PROJECT_ID=!A_Changer!
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=!A_Changer!
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=!A_Changer!
NEXT_PUBLIC_FIREBASE_APP_ID=!A_Changer!
NEXT_PUBLIC_VAPID_KEY=!A_Changer!
# API env vars
WEB_APP_URL=${APP_URL}
APP_SECRET=${APP_SECRET}
DATABASE_URL=postgresql://app:${POSTGRES_PASSWORD}@database:5432/app?serverVersion=15&charset=utf8
JWT_SECRET_KEY=$(tr -d '\n' <<<$APP_JWT_SECRET_KEY)
JWT_PUBLIC_KEY=$(tr -d '\n' <<<$APP_JWT_PUBLIC_KEY)
JWT_PASSPHRASE=$(tr -d '\n' <<<$APP_JWT_PASSPHRASE)
## Mail config
MAILER_SENDER=bikelib@${APP_URL}
MAILER_DSN=mailgun+api://DOMAIN_API_KEY:DOMAIN@default?region=eu
## Firebase
FIREBASE_PROJECT_ID=!A_Changer!
FIREBASE_PRIVATE_KEY_ID=!A_Changer!
FIREBASE_PRIVATE_KEY=!A_Changer!
FIREBASE_CLIENT_EMAIL=!A_Changer!
FIREBASE_CLIENT_ID=!A_Changer!
FIREBASE_AUTH_URI=!A_Changer!
FIREBASE_TOKEN_URI=!A_Changer!
FIREBASE_AUTH_PROVIDER=!A_Changer!
FIREBASE_CLIENT_CERT_URL=!A_Changer!
FIREBASE_UNIVERSE_DOMAIN=!A_Changer!
## S3 Storage
STORAGE_BUCKET=!A_Changer!
STORAGE_ENDPOINT=!A_Changer!
STORAGE_REGION=!A_Changer!
STORAGE_USE_PATH_STYLE_ENDPOINT=true
STORAGE_KEY=!A_Changer!
STORAGE_SECRET=!A_Changer!
# Caddy env vars
MERCURE_SUBSCRIBER_JWT_KEY=$(tr -d '\n' < subscriber.key.pub)
MERCURE_EXTRA_DIRECTIVES=${MERCURE_EXTRA_DIRECTIVES}
MERCURE_PUBLISHER_JWT_KEY=$(tr -d '\n' < publisher.key.pub)
# PostgreSQL env vars
POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
EOF

Build des images

À partir de là, lancer le build des images :

docker compose -f docker-compose.yml -f docker-compose.prod.yml build

Créer ou recréer les conteneurs

Une fois qu'elles sont build, vous n'avez plus qu'à lancer les conteneurs en mode détaché :

docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d

Si besoin de consulter les logs, exécuter la commande suivante :

docker compose -f docker-compose.yml -f docker-compose.prod.yml logs -f

Si besoin de repartir de zéro, exécuter la commande suivante :

docker compose -f docker-compose.yml -f docker-compose.prod.yml down
# Ou, en supprimant aussi les volumes :
docker compose -f docker-compose.yml -f docker-compose.prod.yml down --volumes

Mettre à jour

Pour mettre à jour le déploiement (cas d'une nouvelle release de bikelib par exemple), exécuter les commandes suivantes :

# On télécharge les nouvelles références du dépôt distant
git fetch origin
# On se place sur le dernier tag (release)
git switch -d $(git describe --tags `git rev-list --tags --max-count=1`)
# On rebuild les images
docker compose -f docker-compose.yml -f docker-compose.prod.yml build
# On met à jour les conteneurs
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d