@hed-hog/cli 0.0.49 → 0.0.51

package/dist/src/templates/deployment/DEPLOYMENT.md.ejs

@@ -0,0 +1,217 @@
+# Deployment Guide
+
+This project is configured for deployment to **<%= config.provider === 'digitalocean' ? 'Digital Ocean Kubernetes' : config.provider %>** using **<%= config.cicd === 'github-actions' ? 'GitHub Actions' : config.cicd %>**.
+
+## Prerequisites
+
+Make sure you have the following tools installed:
+
+- `kubectl` - Kubernetes CLI
+- `doctl` - Digital Ocean CLI
+- `gh` - GitHub CLI
+- `helm` - Kubernetes package manager
+
+## Initial Setup
+
+### 1. Configure Digital Ocean
+
+```bash
+# Authenticate with Digital Ocean
+doctl auth init
+
+# Get your cluster kubeconfig
+doctl kubernetes cluster kubeconfig save <%= config.clusterName %>
+```
+
+<% if (config.createNamespace) { %>### 2. Create Kubernetes Namespace
+
+```bash
+kubectl create namespace <%= config.namespace %>
+```
+
+<% } else { %>### 2. Verify Namespace
+
+```bash
+# Verify the namespace exists
+kubectl get namespace <%= config.namespace %>
+```
+
+<% } %>### 3. Configure GitHub Secrets
+
+Add the following secrets to your GitHub repository:
+
+1. `DIGITALOCEAN_ACCESS_TOKEN` - Your Digital Ocean API token
+
+```bash
+# Get your DO token and add it to GitHub
+gh secret set DIGITALOCEAN_ACCESS_TOKEN
+```
+
+<% if (config.setupSSL) { %>### 4. Install cert-manager
+
+```bash
+# Install cert-manager for SSL certificates
+kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.0/cert-manager.yaml
+
+# Wait for cert-manager to be ready
+kubectl wait --for=condition=ready pod -l app.kubernetes.io/instance=cert-manager -n cert-manager --timeout=300s
+
+# Apply the ClusterIssuer
+kubectl apply -f k8s/cert-manager-issuer.yaml
+```
+<% } %>
+<% if (config.setupIngress) { %>### <%= config.setupSSL ? '5' : '4' %>. Install NGINX Ingress Controller
+
+```bash
+# Install NGINX Ingress Controller
+helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+helm repo update
+
+helm install nginx-ingress ingress-nginx/ingress-nginx \
+  --namespace ingress-nginx \
+  --create-namespace \
+  --set controller.publishService.enabled=true
+
+# Wait for the load balancer IP
+kubectl get service nginx-ingress-ingress-nginx-controller -n ingress-nginx --watch
+```
+
+**Important:** After the LoadBalancer gets an external IP, configure your DNS:
+
+<% if (config.domain) { %>- Point `<%= config.domain %>` to the LoadBalancer IP
+<% if (config.apps.includes('api')) { %>- Point `api.<%= config.domain %>` to the LoadBalancer IP
+<% } %><% } %>
+<% } %>
+## Deployment
+
+### Using GitHub Actions (Automatic)
+
+Push to the `<%= config.deployBranch || 'production' %>` branch:
+
+```bash
+git add .
+git commit -m "Deploy to production"
+git push origin <%= config.deployBranch || 'production' %>
+```
+
+The GitHub Actions workflow will automatically:
+1. Apply cluster configuration (namespace, Kubernetes manifests, and Helm charts)
+2. Build and push application Docker images
+3. Update deployments and wait for rollout
+
+### Manual Deployment
+
+#### Option 1: Apply cluster config manually (same as workflow)
+
+```bash
+kubectl create namespace <%= config.namespace %> --dry-run=client -o yaml | kubectl apply -f -
+<% if (config.setupSSL) { %>kubectl apply -f k8s/cert-manager-issuer.yaml
+<% } %><% config.apps.forEach((app) => { %>kubectl apply -f k8s/<%= app %>/ -n <%= config.namespace %>
+<% }); %><% if (config.setupIngress) { %>kubectl apply -f k8s/ingress.yaml -n <%= config.namespace %>
+<% } %>```
+
+<% if ((config.infraServices || []).length > 0) { %>#### Additional infrastructure services (generated from <%= config.composeFileName || 'docker-compose' %>)
+
+The CLI generated Helm charts for the selected services under `helm/services` using the same image names and versions from compose.
+
+Run the following commands to create these services in your cluster:
+
+```bash
+<% (config.infraServices || []).forEach((service) => { %>helm upgrade --install <%= config.appName %>-<%= service.name %> ./helm/services/<%= service.name %> --namespace <%= config.namespace %> --create-namespace
+<% }); %>```
+<% } %>
+
+#### Option 2: Build and deploy application images
+
+```bash
+<% if (config.apps.includes('api')) { %>docker build -t <%= config.containerRegistry %>/<%= config.appName %>-api:latest -f apps/api/Dockerfile .
+docker push <%= config.containerRegistry %>/<%= config.appName %>-api:latest
+kubectl set image deployment/<%= config.appName %>-api <%= config.appName %>-api=<%= config.containerRegistry %>/<%= config.appName %>-api:latest -n <%= config.namespace %>
+kubectl rollout status deployment/<%= config.appName %>-api -n <%= config.namespace %>
+
+<% } %><% if (config.apps.includes('admin')) { %>docker build -t <%= config.containerRegistry %>/<%= config.appName %>-admin:latest \
+  --build-arg NEXT_PUBLIC_API_BASE_URL=<%= config.domain ? `https://api.${config.domain}` : '' %> \
+  --build-arg NEXT_PUBLIC_API_URL=<%= config.domain ? `https://api.${config.domain}` : '' %> \
+  -f apps/admin/Dockerfile .
+docker push <%= config.containerRegistry %>/<%= config.appName %>-admin:latest
+kubectl set image deployment/<%= config.appName %>-admin <%= config.appName %>-admin=<%= config.containerRegistry %>/<%= config.appName %>-admin:latest -n <%= config.namespace %>
+kubectl rollout status deployment/<%= config.appName %>-admin -n <%= config.namespace %>
+<% } %><% (config.apps || []).filter((app) => app !== 'api' && app !== 'admin').forEach((app) => { %>
+docker build -t <%= config.containerRegistry %>/<%= config.appName %>-<%= app %>:latest -f apps/<%= app %>/Dockerfile .
+docker push <%= config.containerRegistry %>/<%= config.appName %>-<%= app %>:latest
+kubectl set image deployment/<%= config.appName %>-<%= app %> <%= config.appName %>-<%= app %>=<%= config.containerRegistry %>/<%= config.appName %>-<%= app %>:latest -n <%= config.namespace %>
+kubectl rollout status deployment/<%= config.appName %>-<%= app %> -n <%= config.namespace %>
+<% }); %>```
+
+## Monitoring
+
+### Check Deployment Status
+
+```bash
+# Check pods
+kubectl get pods -n <%= config.namespace %>
+
+# Check deployments
+kubectl get deployments -n <%= config.namespace %>
+
+# Check services
+kubectl get services -n <%= config.namespace %>
+
+<% if (config.setupIngress) { %># Check ingress
+kubectl get ingress -n <%= config.namespace %>
+<% } %># View logs
+<% config.apps.forEach((app) => { %>kubectl logs -f deployment/<%= config.appName %>-<%= app %> -n <%= config.namespace %>
+<% }); %>```
+
+### Scaling
+
+```bash
+# Scale a deployment
+<% config.apps.forEach((app) => { %>kubectl scale deployment/<%= config.appName %>-<%= app %> --replicas=3 -n <%= config.namespace %>
+<% }); %>```
+
+## Rollback
+
+```bash
+# View rollout history
+<% config.apps.forEach((app) => { %>kubectl rollout history deployment/<%= config.appName %>-<%= app %> -n <%= config.namespace %>
+<% }); %>
+# Rollback to previous version
+<% config.apps.forEach((app) => { %>kubectl rollout undo deployment/<%= config.appName %>-<%= app %> -n <%= config.namespace %>
+<% }); %>```
+
+## Troubleshooting
+
+### View Pod Events
+
+```bash
+kubectl describe pod <pod-name> -n <%= config.namespace %>
+```
+
+### View Cluster Events
+
+```bash
+kubectl get events -n <%= config.namespace %> --sort-by='.lastTimestamp'
+```
+
+### Access Pod Shell
+
+```bash
+<% config.apps.forEach((app) => { %>kubectl exec -it deployment/<%= config.appName %>-<%= app %> -n <%= config.namespace %> -- /bin/sh
+<% }); %>```
+
+## URLs
+
+<% if (config.domain) { %>- **Admin Panel:** https://<%= config.domain %>
+<% if (config.apps.includes('api')) { %>- **API:** https://api.<%= config.domain %>
+<% } %><% } else { %>- Configure your domain and update DNS records as described above
+<% } %>
+
+## Further Reading
+
+- [Digital Ocean Kubernetes Documentation](https://docs.digitalocean.com/products/kubernetes/)
+- [GitHub Actions Documentation](https://docs.github.com/en/actions)
+- [Kubernetes Documentation](https://kubernetes.io/docs/home/)
+- [Helm Documentation](https://helm.sh/docs/)
+<% if (config.setupSSL) { %>- [cert-manager Documentation](https://cert-manager.io/docs/)
+<% } %>

package/dist/src/templates/deployment/helm.service.chart.yaml.ejs

@@ -0,0 +1,6 @@
+apiVersion: v2
+name: <%= service.name %>
+description: Helm chart for <%= service.name %> service (generated from docker-compose)
+type: application
+version: 0.1.0
+appVersion: "1.0.0"

package/dist/src/templates/deployment/helm.service.deployment.yaml.ejs

@@ -0,0 +1,20 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ .Values.serviceName }}
+  namespace: {{ .Values.namespace }}
+spec:
+  replicas: {{ .Values.replicas }}
+  selector:
+    matchLabels:
+      app: {{ .Values.serviceName }}
+  template:
+    metadata:
+      labels:
+        app: {{ .Values.serviceName }}
+    spec:
+      containers:
+        - name: {{ .Values.serviceName }}
+          image: {{ .Values.image }}
+          ports:
+            - containerPort: {{ .Values.service.port }}

package/dist/src/templates/deployment/helm.service.service.yaml.ejs

@@ -0,0 +1,14 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Values.serviceName }}
+  namespace: {{ .Values.namespace }}
+spec:
+  type: {{ .Values.service.type }}
+  selector:
+    app: {{ .Values.serviceName }}
+  ports:
+    - name: tcp
+      protocol: TCP
+      port: {{ .Values.service.port }}
+      targetPort: {{ .Values.service.port }}

package/dist/src/templates/deployment/helm.service.values.yaml.ejs

@@ -0,0 +1,7 @@
+namespace: <%= config.namespace %>
+serviceName: <%= service.name %>
+image: <%= service.image %>
+replicas: 1
+service:
+  type: ClusterIP
+  port: <%= servicePort %>

package/dist/src/templates/deployment/k8s.cert-manager-issuer.yaml.ejs

@@ -0,0 +1,14 @@
+apiVersion: cert-manager.io/v1
+kind: ClusterIssuer
+metadata:
+  name: letsencrypt-prod
+spec:
+  acme:
+    server: https://acme-v02.api.letsencrypt.org/directory
+    email: <%= config.email %>
+    privateKeySecretRef:
+      name: letsencrypt-prod
+    solvers:
+      - http01:
+          ingress:
+            class: nginx

package/dist/src/templates/deployment/k8s.deployment.yaml.ejs

@@ -0,0 +1,14 @@
+apiVersion: apps/v1 kind: Deployment metadata: name: <%= config.appName %>-<%=
+app %> namespace: <%= config.namespace %> labels: app: <%= config.appName %>-<%=
+app %> spec: replicas: <%= config.appReplicas?.[app] ?? 2 %> selector:
+matchLabels: app: <%= config.appName %>-<%= app %> template: metadata: labels:
+app: <%= config.appName %>-<%= app %> spec: containers: - name: <%=
+config.appName %>-<%= app %> image: <%= config.containerRegistry %>/<%=
+config.appName %>-<%= app %>:latest ports: - containerPort: <%=
+config.appPorts?.[app] ?? (app === 'api' ? 3000 : 80) %> env: - name: NODE_ENV
+value: "production" resources: requests: memory: "256Mi" cpu: "100m" limits:
+memory: "512Mi" cpu: "500m" livenessProbe: httpGet: path: <%= app === 'api' ?
+'/health' : '/' %> port: <%= config.appPorts?.[app] ?? (app === 'api' ? 3000 :
+80) %> initialDelaySeconds: 30 periodSeconds: 10 readinessProbe: httpGet: path:
+<%= app === 'api' ? '/health' : '/' %> port: <%= config.appPorts?.[app] ?? (app
+=== 'api' ? 3000 : 80) %> initialDelaySeconds: 10 periodSeconds: 5

package/dist/src/templates/deployment/k8s.ingress.yaml.ejs

@@ -0,0 +1,54 @@
+<%
+  var selectedApps = config.apps || [];
+  var extraApps = selectedApps.filter(function (app) {
+    return app !== 'api' && app !== 'admin';
+  });
+  var appPorts = config.appPorts || {};
+%>
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: <%= config.appName %>-ingress
+  namespace: <%= config.namespace %>
+  annotations:
+    kubernetes.io/ingress.class: "nginx"
+<% if (config.setupSSL) { %>    cert-manager.io/cluster-issuer: "letsencrypt-prod"
+<% } %>spec:
+<% if (config.setupSSL) { %>  tls:
+    - hosts:
+        - <%= config.domain %>
+<% if (selectedApps.includes('api')) { %>        - api.<%= config.domain %>
+<% } %><% extraApps.forEach(function (app) { %>        - <%= app %>.<%= config.domain %>
+<% }); %>      secretName: <%= config.appName %>-tls
+<% } %>  rules:
+<% if (selectedApps.includes('admin')) { %>    - host: <%= config.domain %>
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: <%= config.appName %>-admin
+                port:
+                  number: <%= appPorts.admin || 80 %>
+<% } %><% if (selectedApps.includes('api')) { %>    - host: api.<%= config.domain %>
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: <%= config.appName %>-api
+                port:
+                  number: <%= appPorts.api || 3000 %>
+<% } %><% extraApps.forEach(function (app) { %>    - host: <%= app %>.<%= config.domain %>
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: <%= config.appName %>-<%= app %>
+                port:
+                  number: <%= appPorts[app] || 80 %>
+<% }); %>

package/dist/src/templates/deployment/k8s.service.yaml.ejs

@@ -0,0 +1,6 @@
+apiVersion: v1 kind: Service metadata: name: <%= config.appName %>-<%= app %>
+namespace: <%= config.namespace %> labels: app: <%= config.appName %>-<%= app %>
+spec: type: ClusterIP ports: - port: <%= config.appPorts?.[app] ?? (app ===
+'api' ? 3000 : 80) %> targetPort: <%= config.appPorts?.[app] ?? (app === 'api' ?
+3000 : 80) %> protocol: TCP name: http selector: app: <%= config.appName %>-<%=
+app %>

package/dist/src/templates/deployment/workflow.deploy.yml.ejs

@@ -0,0 +1,133 @@
+name: Deploy to Kubernetes
+on:
+  push:
+    branches:
+      - <%= config.deployBranch || 'production' %>
+  workflow_dispatch:
+env:
+  REGISTRY: <%= config.containerRegistry %>
+  CLUSTER_NAME: <%= config.clusterName %>
+  NAMESPACE: <%= config.namespace %>
+  API_PUBLIC_URL: <%= config.domain ? `https://api.${config.domain}` : '' %>
+jobs:
+  apply-cluster-config:
+    name: Apply Kubernetes and Helm configs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install doctl
+        uses: digitalocean/action-doctl@v2
+        with:
+          token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+      - name: Save DigitalOcean kubeconfig
+        run: doctl kubernetes cluster kubeconfig save ${{ env.CLUSTER_NAME }}
+      - name: Ensure namespace exists
+        run: |
+          kubectl create namespace ${{ env.NAMESPACE }} --dry-run=client -o yaml | kubectl apply -f -
+      - name: Apply Kubernetes manifests
+        run: |
+      <% if (config.setupSSL) { %>          kubectl apply -f k8s/cert-manager-issuer.yaml
+      <% } %><% (config.apps || []).forEach((app) => { %>          kubectl apply -f k8s/<%= app %> -n ${{ env.NAMESPACE }}
+      <% }); %><% if (config.setupIngress) { %>          kubectl apply -f k8s/ingress.yaml -n ${{ env.NAMESPACE }}
+<% } %><% if ((config.infraServices || []).length > 0) { %>      - name: Apply Helm chart(s)
+        run: |
+<% config.infraServices.forEach((service) => { %>          helm upgrade --install <%= config.appName %>-<%= service.name %> ./helm/services/<%= service.name %> \
+            --namespace ${{ env.NAMESPACE }} \
+            --create-namespace
+<% }); %><% } %>
+
+<% if (config.apps.includes('api')) { %>  deploy-api:
+    name: Deploy API
+    runs-on: ubuntu-latest
+    needs: apply-cluster-config
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install doctl
+        uses: digitalocean/action-doctl@v2
+        with:
+          token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
+      - name: Log in to Container Registry
+        run: doctl registry login
+      - name: Build and push Docker image
+        run: |
+          docker build -t ${{ env.REGISTRY }}/<%= config.appName %>-api:${{ github.sha }} \
+            -f apps/api/Dockerfile .
+          docker push ${{ env.REGISTRY }}/<%= config.appName %>-api:${{ github.sha }}
+          docker tag ${{ env.REGISTRY }}/<%= config.appName %>-api:${{ github.sha }} \
+            ${{ env.REGISTRY }}/<%= config.appName %>-api:latest
+          docker push ${{ env.REGISTRY }}/<%= config.appName %>-api:latest
+      - name: Save DigitalOcean kubeconfig
+        run: doctl kubernetes cluster kubeconfig save ${{ env.CLUSTER_NAME }}
+      - name: Deploy to Kubernetes
+        run: |
+          kubectl set image deployment/<%= config.appName %>-api \
+            <%= config.appName %>-api=${{ env.REGISTRY }}/<%= config.appName %>-api:${{ github.sha }} \
+            -n ${{ env.NAMESPACE }}
+          kubectl rollout status deployment/<%= config.appName %>-api -n ${{ env.NAMESPACE }}
+
+<% } %><% if (config.apps.includes('admin')) { %>  deploy-admin:
+    name: Deploy ADMIN
+    runs-on: ubuntu-latest
+    needs: apply-cluster-config
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install doctl
+        uses: digitalocean/action-doctl@v2
+        with:
+          token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
+      - name: Log in to Container Registry
+        run: doctl registry login
+      - name: Build and push Docker image
+        run: |
+          docker build -t ${{ env.REGISTRY }}/<%= config.appName %>-admin:${{ github.sha }} \
+            --build-arg NEXT_PUBLIC_API_BASE_URL=${{ env.API_PUBLIC_URL }} \
+            --build-arg NEXT_PUBLIC_API_URL=${{ env.API_PUBLIC_URL }} \
+            -f apps/admin/Dockerfile .
+          docker push ${{ env.REGISTRY }}/<%= config.appName %>-admin:${{ github.sha }}
+          docker tag ${{ env.REGISTRY }}/<%= config.appName %>-admin:${{ github.sha }} \
+            ${{ env.REGISTRY }}/<%= config.appName %>-admin:latest
+          docker push ${{ env.REGISTRY }}/<%= config.appName %>-admin:latest
+      - name: Save DigitalOcean kubeconfig
+        run: doctl kubernetes cluster kubeconfig save ${{ env.CLUSTER_NAME }}
+      - name: Deploy to Kubernetes
+        run: |
+          kubectl set image deployment/<%= config.appName %>-admin \
+            <%= config.appName %>-admin=${{ env.REGISTRY }}/<%= config.appName %>-admin:${{ github.sha }} \
+            -n ${{ env.NAMESPACE }}
+          kubectl rollout status deployment/<%= config.appName %>-admin -n ${{ env.NAMESPACE }}
+<% } %><% (config.apps || []).filter((app) => app !== 'api' && app !== 'admin').forEach((app) => { %>
+  deploy-<%= app %>:
+    name: Deploy <%= app.toUpperCase() %>
+    runs-on: ubuntu-latest
+    needs: apply-cluster-config
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install doctl
+        uses: digitalocean/action-doctl@v2
+        with:
+          token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
+      - name: Log in to Container Registry
+        run: doctl registry login
+      - name: Build and push Docker image
+        run: |
+          docker build -t ${{ env.REGISTRY }}/<%= config.appName %>-<%= app %>:${{ github.sha }} \
+            -f apps/<%= app %>/Dockerfile .
+          docker push ${{ env.REGISTRY }}/<%= config.appName %>-<%= app %>:${{ github.sha }}
+          docker tag ${{ env.REGISTRY }}/<%= config.appName %>-<%= app %>:${{ github.sha }} \
+            ${{ env.REGISTRY }}/<%= config.appName %>-<%= app %>:latest
+          docker push ${{ env.REGISTRY }}/<%= config.appName %>-<%= app %>:latest
+      - name: Save DigitalOcean kubeconfig
+        run: doctl kubernetes cluster kubeconfig save ${{ env.CLUSTER_NAME }}
+      - name: Deploy to Kubernetes
+        run: |
+          kubectl set image deployment/<%= config.appName %>-<%= app %> \
+            <%= config.appName %>-<%= app %>=${{ env.REGISTRY }}/<%= config.appName %>-<%= app %>:${{ github.sha }} \
+            -n ${{ env.NAMESPACE }}
+          kubectl rollout status deployment/<%= config.appName %>-<%= app %> -n ${{ env.NAMESPACE }}
+<% }); %>