fix: improvements to onboarding (#65)

A bunch of improvements and fixes related to the getting started
experience with draft. Thanks to @josephhilby for helping find some of
these.

Changes (in no particular order):
- Removed old `.vscode/launch.json` configurations (and fixed others)
- Added a Docker compose file for easily starting core services (but see
#69 for an even better way to do this)
- Removed old (unused) deployment files
- Cleaned up logging and configuration for blueprint
- Removed unused catalyst web-client
- Added catalyst config file and updated chassis dependency
- Updated example services to use latest chassis and updated configs to
match new core service deployment
- Removed unnecessary expose of ports in Dockerfile
- Added infra configs to dctl context
- Added a `--full` flag to `infra clean` to allow removing contains
without deleting config and data

Author: jgkawell

.vscode/launch.json

@@ -4,27 +4,6 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
-        {
-            "name": "Gateway",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "services/core/gateway/main.go",
-            "cwd": "${workspaceFolder}",
-            "debugAdapter": "dlv-dap",
-            "args": [
-                "run"
-            ]
-        },
-        {
-            "name": "Host",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "services/core/host/main.go",
-            "cwd": "${workspaceFolder}",
-            "debugAdapter": "dlv-dap",
-        },
         {
             "name": "Blueprint CMD: Register Cluster",
             "type": "go",
@@ -166,7 +145,7 @@
             "cwd": "${workspaceFolder}",
             "debugAdapter": "dlv-dap",
             "env": {
-                "DRAFT_CONFIG": "tests/catalyst/config.yaml"
+                "DRAFT_CONFIG": "services/core/catalyst/config.yaml"
             },
         },
         {
@@ -198,7 +177,7 @@
             "cwd": "${workspaceFolder}",
             "debugAdapter": "dlv-dap",
             "env": {
-                "DRAFT_CONFIG": "tests/fuse/config.yaml"
+                "DRAFT_CONFIG": "services/core/fuse/config.yaml"
             },
         },
         {

Dockerfile

@@ -67,11 +67,3 @@ WORKDIR /etc
 
 # Run
 ENTRYPOINT ["/etc/main"]
-
-# Runtime arguments
-ARG HTTP_PORT=8080
-ARG GRPC_PORT=8090
-
-# Expose needed ports
-EXPOSE ${HTTP_PORT}
-EXPOSE ${GRPC_PORT}

README.md

@@ -43,15 +43,15 @@ Here are some simple descriptions of what you'll find in each directory:
 
 * [Go](https://golang.org/doc/install) v1.21 (we suggest using [gvm](https://github.com/moovweb/gvm) for easier version management)
 * [Docker](https://docs.docker.com/get-docker/)
-* [Kubernetes](https://kubernetes.io/docs/tasks/tools/) (this is for running testing suites locally: if on Mac or Windows you can use the Kubernetes engine built into Docker Desktop)
+* [Kubernetes](https://kubernetes.io/docs/tasks/tools/) (this is for running testing suites locally; if on Mac or Windows you can use the Kubernetes engine built into Docker Desktop)
 
 You'll need the `dctl` CLI tool to work with everything in Draft. Let's install it now:
 
 ```shell
 go install github.com/steady-bytes/draft/tools/dctl@latest
 ```
 
-We'll need to import this project as a usable context into `dctl` so it can manage things for us. After cloning the repo run the below command from the root of the repo:
+We'll need to import this project as a usable context into `dctl` so it can manage things for us. After cloning the repo run the below command from inside the repo:
 
 ```shell
 dctl context import
@@ -64,12 +64,12 @@ Now you can set up your local environment:
 dctl infra init
 dctl infra start
 
+# test run some domains
+dctl run --domains examples
+
 # initialize and do a first generation of the API
 dctl api init
 dctl api build
-
-# test run some domains
-dctl run --domains core,examples
 ```
 
 ## Future Components

api/buf.lock

@@ -9,8 +9,8 @@ deps:
   - remote: buf.build
     owner: googleapis
     repository: googleapis
-    commit: acd896313c55464b993332136ded1b6e
-    digest: shake256:66626d5e4d9c8ecf25cd72bdbfbbf62b9a68e9e9c33dab6b9b39a53a67063eeba6b8493247dd6d6240b1ac1c32eb2dc311484e67dd7d271884a960c2e5ce8c9a
+    commit: 751cbe31638d43a9bfb6162cd2352e67
+    digest: shake256:87f55470d9d124e2d1dedfe0231221f4ed7efbc55bc5268917c678e2d9b9c41573a7f9a557f6d8539044524d9fc5ca8fbb7db05eb81379d168285d76b57eb8a4
   - remote: buf.build
     owner: srikrsna
     repository: protoc-gen-gotag

deployments/compose/blueprint.yaml

@@ -0,0 +1,20 @@
+service:
+  name: blueprint
+  domain: core
+
+  logging:
+    level: info
+
+  network:
+    bind_address: 0.0.0.0
+    bind_port: 2221
+
+
+badger:
+  path: /etc/badger
+
+raft:
+  node-id: node_1
+  address: localhost
+  port: 1111
+  bootstrap: true

deployments/compose/catalyst.yaml

@@ -0,0 +1,14 @@
+service:
+  name: catalyst
+  domain: core
+  entrypoint: http://blueprint:2221
+
+  logging:
+    level: info
+
+  network:
+    bind_address: 0.0.0.0
+    bind_port: 2220
+    internal:
+      host: localhost
+      port: 2220

deployments/compose/docker-compose.yaml

@@ -0,0 +1,46 @@
+name: draft-core
+services:
+  blueprint:
+    image: ghcr.io/steady-bytes/draft-core-blueprint:latest
+    restart: unless-stopped
+    ports:
+      - 2221:2221
+      - 1111:1111
+    volumes:
+      - ./blueprint.yaml:/etc/config.yaml
+      - blueprint:/etc/badger
+  catalyst:
+    image: ghcr.io/steady-bytes/draft-core-catalyst:latest
+    restart: unless-stopped
+    ports:
+      - 2220:2220
+    volumes:
+      - ./catalyst.yaml:/etc/config.yaml
+    depends_on:
+      blueprint:
+        condition: service_started
+  fuse:
+    image: ghcr.io/steady-bytes/draft-core-fuse:latest
+    restart: unless-stopped
+    ports:
+      - 18000:18000
+    volumes:
+      - ./fuse.yaml:/etc/config.yaml
+    depends_on:
+      blueprint:
+        condition: service_started
+  envoy:
+    image: envoyproxy/envoy:v1.31.2
+    restart: unless-stopped
+    ports:
+      - 10000:10000
+      - 19000:19000
+      - 18090:18090
+    volumes:
+      - ./envoy.yaml:/etc/envoy/envoy.yaml
+    depends_on:
+      fuse:
+        condition: service_started
+
+volumes:
+  blueprint:

deployments/compose/envoy.yaml

@@ -0,0 +1,73 @@
+node:
+  cluster: fuse-proxy
+  id: fuse-proxy-1
+
+admin:
+  access_log_path: /dev/null
+  address:
+    socket_address:
+      address: 0.0.0.0
+      port_value: 19000
+
+dynamic_resources:
+  cds_config:
+    resource_api_version: V3
+    api_config_source:
+      api_type: GRPC
+      transport_api_version: V3
+      grpc_services:
+        - envoy_grpc:
+            cluster_name: xds_cluster
+      set_node_on_first_message_only: true
+  lds_config:
+    resource_api_version: V3
+    api_config_source:
+      api_type: GRPC
+      transport_api_version: V3
+      grpc_services:
+        - envoy_grpc:
+            cluster_name: xds_cluster
+      set_node_on_first_message_only: true
+
+static_resources:
+  clusters:
+    - name: xds_cluster
+      connect_timeout: 1s
+      load_assignment:
+        cluster_name: xds_cluster
+        endpoints:
+          - lb_endpoints:
+              - endpoint:
+                  address:
+                    socket_address:
+                      # address in which fuse is running on
+                      address: fuse
+                      port_value: 18000
+      http2_protocol_options: {}
+      type: STRICT_DNS
+    - name: als_cluster
+      connect_timeout: 1s
+      load_assignment:
+        cluster_name: als_cluster
+        endpoints:
+          - lb_endpoints:
+              - endpoint:
+                  address:
+                    socket_address:
+                      address: 0.0.0.0
+                      port_value: 18090
+      http2_protocol_options: {}
+
+layered_runtime:
+  layers:
+    - name: runtime-0
+      rtds_layer:
+        rtds_config:
+          resource_api_version: V3
+          api_config_source:
+            transport_api_version: V3
+            api_type: GRPC
+            grpc_services:
+              envoy_grpc:
+                cluster_name: xds_cluster
+        name: runtime-0

deployments/compose/fuse.yaml

@@ -0,0 +1,20 @@
+service:
+  name: fuse
+  domain: core
+  entrypoint: http://blueprint:2221
+
+  logging:
+    level: info
+
+  network:
+    bind_address: 0.0.0.0
+    bind_port: 18000
+    internal:
+      host: localhost
+      port: 18000
+
+fuse:
+  address: http://localhost:18000
+  listener:
+    address: 0.0.0.0
+    port: 10000