Added Code-Server-Sidecar Template

.bunnyshell/templates/code-server-sidecar/README.md

@@ -0,0 +1,177 @@
+### Documentation for Integrating VS Code as a Sidecar Container using Bunnyshell
+
+## Overview
+
+This documentation provides a step-by-step guide to integrate VS Code as a sidecar container for remote development using Bunnyshell. The provided `bunnyshell.yaml` template showcases how to achieve this setup effectively.
+
+## Pre-Requisites
+
+### Adjusting the Dockerfile
+
+To integrate VS Code and avoid permission issues when mounting volumes across containers, you need to adjust the UID and GID of the files in your Dockerfile as follows:
+
+1. **Add a user with UID 1000 and GID 1000:**
+    NOTE: You are not restricted to using UID 1000 or GID 1000. Make sure to update the sidecar PUID and GUID accordingly.
+    ```Dockerfile
+    RUN addgroup -g 1000 code-server-user && \
+        adduser -D -u 1000 -G code-server-user code-server-user && \
+        adduser code-server-user nginx
+    ```
+
+2. **Modify the main command to ensure proper permissions:**
+This can be achieved by either modifying the main command with a `RUN` command or by adding to the `ENTRYPOINT` script to ensure the `code-server-user` has the correct permissions over the necessary directories.
+
+    ```Dockerfile
+    CMD ["sh", "-c", "chown -R code-server-user:code-server-user /usr/share/nginx/html && nginx -g 'daemon off;'"]
+    ```
+
+
+### Understanding the Need for UID and GID
+
+When mounting volumes across containers, permission issues can arise between the main and sidecar containers. Specifying the user PUID and group PGID ensures consistency and avoids these issues. Use the command `id your_user` to find your user and group IDs.
+
+## Template Variables Explained
+
+### Crucial Lines in the `bunnyshell.yaml`
+
+1. **Exposing the Port for the Sidecar Container:**
+
+    ```yaml
+    dockerCompose:
+        ports:
+            - '80:80'
+            - '8443:8443'
+    ```
+
+2. **Defining the Sidecar Container:**
+
+    ```yaml
+    dockerCompose:
+        pod:
+            sidecar_containers:
+                -
+                    from: code-server
+                    name: sidecar-code-server
+                    shared_paths:
+                        -
+                            path: /config/workspace
+                            target:
+                                path: /usr/share/nginx/html
+                                container: '@parent'
+                            initial_contents: '@target'
+    ```
+
+    - `shared_paths[0].path`: The default workspace opened in the IDE.
+    - `shared_paths[0].target.path`: The path where the source code is in the main pod.
+
+3. **Generating the Hostname for the Code Server Sidecar:**
+
+    ```yaml
+    hosts:
+        -
+            hostname: '{{template.vars.CODE_SERVER_HOST}}'
+            path: /
+            servicePort: '8443'
+    ```
+
+4. **Code-Server Environment Variables:**
+
+    Refer to [Code-Server Environment Variables Documentation](https://docs.linuxserver.io/images/docker-code-server/#environment-variables-from-files-docker-secrets).
+
+    ```yaml
+    dockerCompose:
+        environment:
+            DEFAULT_WORKSPACE: '/config/workspace'
+            HASHED_PASSWORD: {{template.vars.HASHED_PASSWORD}}
+            PASSWORD: {{template.vars.PASSWORD}}
+            PGID: '{{template.vars.PGID}}'
+            PROXY_DOMAIN: {{template.vars.PROXY_DOMAIN}}
+            PUID: '{{template.vars.PUID}}'
+            SUDO_PASSWORD: {{template.vars.SUDO_PASSWORD}}
+            SUDO_PASSWORD_HASH: {{template.vars.SUDO_PASSWORD_HASH}}
+            TZ: {{ template.vars.TZ }}
+    ```
+
+    - `PUID=1000`: UserID.
+    - `PGID=1000`: GroupID.
+    - `TZ=Etc/UTC`: Specify a timezone.
+    - `PASSWORD=password`: Optional web GUI password.
+    - `HASHED_PASSWORD=`: Optional hashed web GUI password.
+    - `SUDO_PASSWORD=password`: Optional sudo password.
+    - `SUDO_PASSWORD_HASH=`: Optionally set sudo password via hash.
+    - `PROXY_DOMAIN=code-server.my.domain`: Optional proxy domain.
+    - `DEFAULT_WORKSPACE=/config/workspace`: Default workspace directory.
+
+## Example `bunnyshell.yaml` File
+
+Below is the full `bunnyshell.yaml` configuration template:
+
+```yaml
+kind: Environment
+name: code-server
+type: primary
+templateVariables:
+    CODE_SERVER_HOST: code-server-{{env.base_domain}}
+    HASHED_PASSWORD: ''
+    PASSWORD: password
+    PGID: '1000'
+    PROXY_DOMAIN: ''
+    PUID: '1000'
+    SUDO_PASSWORD: password
+    SUDO_PASSWORD_HASH: ''
+    TZ: Etc/UTC
+components:
+    -
+        kind: Application
+        name: sample-app
+        gitRepo: 'https://github.com/aminalali8/mini-web.git'
+        gitBranch: master
+        gitApplicationPath: /
+        dockerCompose:
+            build:
+                context: .
+                dockerfile: Dockerfile
+            ports:
+                - '80:80'
+                - '8443:8443'
+        pod:
+            sidecar_containers:
+                -
+                    from: code-server
+                    name: sidecar-code-server
+                    shared_paths:
+                        -
+                            path: /config/workspace
+                            target:
+                                path: /usr/share/nginx/html
+                                container: '@parent'
+                            initial_contents: '@target'
+        hosts:
+            -
+                hostname: 'web-{{env.base_domain}}'
+                path: /
+                servicePort: 80
+            -
+                hostname: '{{template.vars.CODE_SERVER_HOST}}'
+                path: /
+                servicePort: '8443'
+    -
+        kind: SidecarContainer
+        name: code-server
+        dockerCompose:
+            image: 'lscr.io/linuxserver/code-server:latest'
+            environment:
+                DEFAULT_WORKSPACE: '/config/workspace'
+                HASHED_PASSWORD: {{template.vars.HASHED_PASSWORD}}
+                PASSWORD: {{template.vars.PASSWORD}}
+                PGID: '{{template.vars.PGID}}'
+                PROXY_DOMAIN: {{template.vars.PROXY_DOMAIN}}
+                PUID: '{{template.vars.PUID}}'
+                SUDO_PASSWORD: '{{template.vars.SUDO_PASSWORD}}'
+                SUDO_PASSWORD_HASH: '{{template.vars.SUDO_PASSWORD_HASH}}'
+                TZ: '{{template.vars.TZ}}'
+            ports:
+                - '8443:8443'
+```
+
+This template facilitates the integration of VS Code as a sidecar container for remote development, ensuring a seamless and efficient development workflow. Adjust the provided `bunnyshell.yaml` and Dockerfile snippets to suit your application's needs. For further customization, refer to the [Code-Server Environment Variables Documentation](https://docs.linuxserver.io/images/docker-code-server/#environment-variables-from-files-docker-secrets).

.bunnyshell/templates/code-server-sidecar/bunnyshell.yaml

@@ -0,0 +1,65 @@
+kind: Environment
+name: code-server
+type: primary
+templateVariables:
+    CODE_SERVER_HOST: code-server-{{env.base_domain}}
+    HASHED_PASSWORD: ''
+    PASSWORD: password
+    PGID: '1000'
+    PROXY_DOMAIN: ''
+    PUID: '1000'
+    SUDO_PASSWORD: password
+    SUDO_PASSWORD_HASH: ''
+    TZ: Etc/UTC
+components:
+    -
+        kind: Application
+        name: sample-app
+        gitRepo: 'https://github.com/aminalali8/mini-web.git'
+        gitBranch: master
+        gitApplicationPath: /
+        dockerCompose:
+            build:
+                context: .
+                dockerfile: Dockerfile
+            ports:
+                - '80:80'
+                - '8443:8443'
+        pod:
+            sidecar_containers:
+                -
+                    from: code-server
+                    name: sidecar-code-server
+                    shared_paths:
+                        -
+                            path: /config/workspace
+                            target:
+                                path: /usr/share/nginx/html
+                                container: '@parent'
+                            initial_contents: '@target'
+        hosts:
+            -
+                hostname: 'web-{{env.base_domain}}'
+                path: /
+                servicePort: 80
+            -
+                hostname: '{{template.vars.CODE_SERVER_HOST}}'
+                path: /
+                servicePort: 8443
+    -
+        kind: SidecarContainer
+        name: code-server
+        dockerCompose:
+            image: 'lscr.io/linuxserver/code-server:4.90.3'
+            environment:
+                DEFAULT_WORKSPACE: /config/workspace
+                HASHED_PASSWORD: '{{template.vars.HASHED_PASSWORD}}'
+                PASSWORD: '{{template.vars.PASSWORD}}'
+                PGID: '{{template.vars.PGID}}'
+                PROXY_DOMAIN: '{{template.vars.PROXY_DOMAIN}}'
+                PUID: '{{template.vars.PUID}}'
+                SUDO_PASSWORD: '{{template.vars.SUDO_PASSWORD}}'
+                SUDO_PASSWORD_HASH: '{{template.vars.SUDO_PASSWORD_HASH}}'
+                TZ: '{{ template.vars.TZ }}'
+            ports:
+                - '8443:8443'

.bunnyshell/templates/code-server-sidecar/template.yaml

@@ -0,0 +1,14 @@
+name: VS Code Sidecar Integration
+description: This template showcases how to integrate VS Code as a sidecar container for remote development using Bunnyshell. It includes a sample application with a backend service and demonstrates how to configure the environment to avoid permission issues when mounting volumes across containers.
+tags:
+    - vscode
+    - remote-development
+    - sidecar
+icons: [ 'vscode', 'docker' ]
+stack:
+  packages:
+    - name: Linuxserver CodeServer
+      version: '4.90.3'
+discoverable: true
+categories:
+    - web-ides