fix(development): make development environment work by default (#1264)

Signed-off-by: Miguel <[email protected]>

Author: migmartri

app/controlplane/configs/config.devel.yaml

@@ -55,7 +55,7 @@ data:
 # Development credentials for the SSO authentication roundtrip
 auth:
   oidc:
-    domain: ${DEX_DOMAIN:http://dex:5556/dex}
+    domain: ${DEX_DOMAIN:http://0.0.0.0:5556/dex}
     client_id: "chainloop-dev"
     client_secret: "ZXhhbXBsZS1hcHAtc2VjcmV0"
 

devel/README.md

@@ -120,3 +120,44 @@ Running the following command fixes the issue:
 ```
 sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock
 ```
+
+## Labs Environments
+
+For quick testing you can use the provided `compose.labs.yml` file to run the Chainloop components and the auxiliary services.
+
+### 0 - Prerequisites
+
+- Docker and Docker Compose
+- Add entry in `/etc/hosts` for the hostname `dex` pointing to `127.0.0.1`
+
+
+### 1 - Run Containerized Environment
+
+Run the labs environment
+
+```sh
+docker compose -f compose.labs.yml up
+```
+
+
+### 2 - Configure Chainloop CLI
+
+Download Chainloop CLI
+
+```sh
+curl -sfL https://docs.chainloop.dev/install.sh | bash -s
+```
+
+Configure the CLI to point to the local control plane and CAS services.
+
+```sh
+chainloop config save --insecure --control-plane localhost:9000 --artifact-cas localhost:9001
+```
+
+and login
+
+```
+chainloop --insecure auth login 
+```
+
+you are now ready to use the CLI and follow the [quickstart guide](https://docs.chainloop.dev/quickstart) 

devel/compose.common.yml

@@ -0,0 +1,36 @@
+# NOTE: This setup is meant to be used for development purposes only.
+services:
+  postgresql:
+    image: docker.io/bitnami/postgresql:16
+    # Expose the port to the host to enable baremetal controlplane development
+    ports:
+      - 5432:5432
+    volumes:
+      - postgresql_data:/bitnami/postgresql
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - POSTGRESQL_DATABASE=controlplane
+      - POSTGRESQL_USERNAME=postgres
+    healthcheck:
+      test: ["CMD", "pg_isready", "-U", "postgres"]
+      interval: 2s
+      retries: 10
+
+  # in memory-only vault for development
+  # note that secrets will get removed when the container is restarted
+  vault:
+    image: docker.io/vault:1.12.3
+    cap_add:
+      - IPC_LOCK
+    ports:
+      - 8200:8200
+    environment:
+      - VAULT_DEV_ROOT_TOKEN_ID=notasecret
+    healthcheck:
+      test: [ "CMD", "wget", "--spider", "http://127.0.0.1:8200/v1/sys/health" ]
+      interval: 10s
+      timeout: 3s
+      retries: 10
+      start_period: 5s
+volumes:
+  postgresql_data:

devel/labs.compose.yaml devel/compose.labs.yaml

@@ -1,8 +1,18 @@
 name: chainloop-lab
 
 include:
-  - ./compose.yml
+  - ./compose.common.yml
 services:
+  # OIDC provider for labs
+  dex:
+    volumes:
+      - ".:/wd"
+    image: docker.io/bitnami/dex:2
+    working_dir: /wd/dex
+    command: "serve config.labs.yaml"
+    ports:
+      - "0.0.0.0:5556:5556/tcp"
+
   # The control plane is the main service
   control-plane:
     image: ghcr.io/chainloop-dev/chainloop/control-plane:latest

devel/compose.yml

@@ -1,38 +1,9 @@
-# NOTE: This setup is meant to be used for development purposes only.
-services:
-  postgresql:
-    image: docker.io/bitnami/postgresql:16
-    # Expose the port to the host to enable baremetal controlplane development
-    ports:
-      - 5432:5432
-    volumes:
-      - postgresql_data:/bitnami/postgresql
-    environment:
-      - ALLOW_EMPTY_PASSWORD=yes
-      - POSTGRESQL_DATABASE=controlplane
-      - POSTGRESQL_USERNAME=postgres
-    healthcheck:
-      test: ["CMD", "pg_isready", "-U", "postgres"]
-      interval: 2s
-      retries: 10
-
-  # in memory-only vault for development
-  # note that secrets will get removed when the container is restarted
-  vault:
-    image: docker.io/vault:1.12.3
-    cap_add:
-      - IPC_LOCK
-    ports:
-      - 8200:8200
-    environment:
-      - VAULT_DEV_ROOT_TOKEN_ID=notasecret
-    healthcheck:
-      test: [ "CMD", "wget", "--spider", "http://127.0.0.1:8200/v1/sys/health" ]
-      interval: 10s
-      timeout: 3s
-      retries: 10
-      start_period: 5s
+# NOTE: By default this file runs a development setup. 
+# To run a labs setup, use `docker-compose -f compose.labs.yml up`
+include:
+  - ./compose.common.yml
 
+services:
   # OIDC provider for development
   dex:
     volumes:
@@ -43,5 +14,3 @@ services:
     ports:
       - "0.0.0.0:5556:5556/tcp"
 
-volumes:
-  postgresql_data:

devel/dex/config.dev.yaml

@@ -1,5 +1,4 @@
-# this requires adding an entry `127.0.0.1 dex` to /etc/hosts
-issuer: http://dex:5556/dex
+issuer: "http://0.0.0.0:5556/dex"
 
 storage:
   type: memory

devel/dex/config.labs.yaml

@@ -0,0 +1,26 @@
+issuer: "http://dex:5556/dex"
+
+storage:
+  type: memory
+
+web:
+  http: 0.0.0.0:5556
+
+staticClients:
+  - id: chainloop-dev
+    redirectURIs:
+      - "http://0.0.0.0:8000/auth/callback"
+      - "http://localhost:8000/auth/callback"
+    name: "Chainloop Dev"
+    secret: ZXhhbXBsZS1hcHAtc2VjcmV0
+
+# required to enable static passwords
+enablePasswordDB: true
+
+staticPasswords:
+  - email: "[email protected]"
+    # password: "password"
+    hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"
+  - email: "[email protected]"
+    # password: "password"
+    hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"