Skip to content

Feat/registry and evault provisioning #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 20, 2025
Merged

Feat/registry and evault provisioning #106

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54d1f56
feat: evault provisioning
coodos Apr 19, 2025
d55eb00
chore: fianlly fixed provisioner
coodos Apr 20, 2025
82b6a1c
feat: add logic for metadata in consul
coodos Apr 20, 2025
cec8bfd
feat: registry
coodos Apr 20, 2025
73a01b8
chore: format
coodos Apr 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docker/Dockerfile.evault
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ WORKDIR /app
RUN npm i -g corepack@latest
COPY --from=deps /out/ /app
EXPOSE 4000
workdir /app/infrastructure/evault-core
WORKDIR /app/infrastructure/evault-core
CMD ["pnpm", "dev"]
24 changes: 24 additions & 0 deletions docker/Dockerfile.evault-prod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
FROM node:22-slim AS deps
ENV PNPM_HOME="/pnpm"
ENV PATH="$PNPM_HOME:$PATH"
RUN corepack enable
COPY . /app
WORKDIR /app
RUN npm i -g corepack@latest
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --frozen-lockfile
RUN pnpm turbo prune evault-core --docker --use-gitignore=false
RUN mkdir /out
RUN cp -R ./out/full/* /out/
RUN cp -R ./out/json/* /out/
RUN cp ./out/pnpm-lock.yaml /out/pnpm-lock.yaml
RUN cp -R node_modules/ /out/


FROM node:22-slim AS core-api
WORKDIR /app
RUN npm i -g corepack@latest
COPY --from=deps /out/ /app
RUN pnpm -F=evault-core build
EXPOSE 4000
WORKDIR /app/infrastructure/evault-core
CMD ["echo \'hi'\"]
Comment on lines +17 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

⚠️ Potential issue

Missing proper start command in Dockerfile

The CMD is just a placeholder echo command and doesn't actually start the application. This will prevent the container from running properly.

-CMD ["echo \'hi'\"]
+CMD ["node", "dist/index.js"]

Additional recommendations:

  1. Consider using a more stable Node.js version for production (e.g., node:20-slim)
  2. Add a non-root user for security
  3. Include a HEALTHCHECK directive
+RUN groupadd -r evault && useradd -r -g evault evault
+USER evault
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 CMD [ "curl", "-f", "http://localhost:4000/health" ]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
FROM node:22-slim AS core-api
WORKDIR /app
RUN npm i -g corepack@latest
COPY --from=deps /out/ /app
RUN pnpm -F=evault-core build
EXPOSE 4000
WORKDIR /app/infrastructure/evault-core
CMD ["echo \'hi'\"]
FROM node:22-slim AS core-api
WORKDIR /app
RUN npm i -g corepack@latest
COPY --from=deps /out/ /app
RUN pnpm -F=evault-core build
# Add a non-root user for security
RUN groupadd -r evault && useradd -r -g evault evault
USER evault
EXPOSE 4000
WORKDIR /app/infrastructure/evault-core
# Healthcheck to ensure the service is up
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD ["curl", "-f", "http://localhost:4000/health"]
# Start the application
CMD ["node", "dist/index.js"]

3 changes: 2 additions & 1 deletion infrastructure/evault-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"scripts": {
"test": "vitest --config vitest.config.ts",
"build": "tsc",
"dev": "node --watch --import tsx src/evault.ts"
"dev": "node --watch --import tsx src/evault.ts",
"start": "node ./dist/evault.js"
},
"packageManager": "[email protected]",
"keywords": [],
Expand Down
8 changes: 4 additions & 4 deletions infrastructure/evault-core/src/evault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ class EVault {
}

start() {
const port = process.env.PORT ?? 4000;
this.server.listen(port, () => {
console.log(`GraphQL Server started on http://localhost:${port}`);
console.log(`Voyager started on http://localhost:${port}`);
const port = process.env.NOMAD_PORT_http || process.env.PORT || 4000;
this.server.listen(Number(port), "0.0.0.0", () => {
console.log(`GraphQL Server started on http://0.0.0.0:${port}`);
console.log(`Voyager started on http://0.0.0.0:${port}`);
});
}
}
Expand Down
41 changes: 25 additions & 16 deletions infrastructure/evault-core/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
{
"compilerOptions": {
"target": "ES2017",
"module": "ESNext",
"lib": ["ESNext", "DOM"],
"declaration": true,
"declarationDir": "./dist/types",
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"moduleResolution": "Node",
"skipLibCheck": true
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist"]
"compilerOptions": {
"target": "ES2021",
"module": "CommonJS",
"lib": [
"ESNext",
"DOM"
],
"declaration": true,
"declarationDir": "./dist/types",
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"moduleResolution": "Node",
"skipLibCheck": true
},
"include": [
"src/**/*"
],
"exclude": [
"node_modules",
"dist",
"*/**/*.spec.ts"
]
}
188 changes: 188 additions & 0 deletions infrastructure/evault-provisioner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
# Evault Provisioner

A TypeScript API for provisioning evault instances on Nomad. This service allows you to spin up evault instances with Neo4j backends for different tenants.

## Prerequisites

- Node.js 18+
- Docker
- Nomad (see setup instructions below)
- OrbStack (for macOS users)

## Nomad Setup

### macOS Setup (using OrbStack)

Due to CNI bridge plugin requirements, running Nomad on macOS is best done through OrbStack:

1. Install OrbStack: https://orbstack.dev/
2. Create a new VM in OrbStack
3. SSH into the VM and install Nomad:

```bash
# Install Nomad
curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
sudo apt-get update && sudo apt-get install nomad

# Install CNI plugins
sudo mkdir -p /opt/cni/bin
curl -L https://github.com/containernetworking/plugins/releases/download/v1.3.0/cni-plugins-linux-amd64-v1.3.0.tgz | sudo tar -C /opt/cni/bin -xz
```

4. Start Nomad in dev mode:

```bash
sudo nomad agent -dev -network-interface=eth0 -log-level=DEBUG -bind=0.0.0.0
```

### Linux Setup

1. Install Nomad:

```bash
# Install Nomad
curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -
sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"
sudo apt-get update && sudo apt-get install nomad

# Install CNI plugins
sudo mkdir -p /opt/cni/bin
curl -L https://github.com/containernetworking/plugins/releases/download/v1.3.0/cni-plugins-linux-amd64-v1.3.0.tgz | sudo tar -C /opt/cni/bin -xz
```

2. Start Nomad in dev mode:

```bash
sudo nomad agent -dev -network-interface=eth0 -log-level=DEBUG -bind=0.0.0.0
```

## Project Setup

1. Install dependencies:

```bash
npm install
```

2. Build the project:

```bash
npm run build
```

3. Start the server:

```bash
npm start
```

For development with auto-reload:

```bash
npm run dev
```

## API Endpoints

### Health Check

```
GET /health
```

Returns the health status of the API.

### Provision Evault

```
POST /provision
```

Provisions a new evault instance for a tenant.

Request body:

```json
{
"tenantId": "your-tenant-id"
}
```
Comment on lines +106 to +110
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Update API documentation to match code implementation.

The request body example shows tenantId but the actual implementation in the code uses w3id. This inconsistency could confuse API users.

{
-  "tenantId": "your-tenant-id"
+  "w3id": "your-w3id"
}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```json
{
"tenantId": "your-tenant-id"
}
```


Response:

```json
{
"success": true,
"message": "Successfully provisioned evault for tenant your-tenant-id",
"jobName": "evault-your-tenant-id"
}
```

## Architecture

The provisioner creates a Nomad job that consists of two tasks:

1. **Neo4j Task**:

- Runs Neo4j 5.15
- Exposes ports: 7687 (bolt) and 7474 (browser)
- Uses dynamic ports for flexibility
- 2GB memory allocation

2. **Evault Task**:
- Runs the evault application
- Connects to Neo4j via localhost
- Uses dynamic port allocation
- 512MB memory allocation
- Depends on Neo4j task

## Environment Variables

- `PORT` - Port to run the API on (default: 3000)
- `NOMAD_ADDR` - Nomad API address (default: http://localhost:4646)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Use Markdown link syntax and update for consistency with code.

Use link syntax for the URL and note that this environment variable isn't currently used in the code.

-NOMAD_ADDR` - Nomad API address (default: http://localhost:4646)
+NOMAD_ADDR` - Nomad API address (default: [http://localhost:4646](http://localhost:4646)) - *Note: Implementation pending*

This environment variable is documented but not yet implemented in the code. Make sure to update the code to use this variable as shown in a previous comment.

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

143-143: Bare URL used
null

(MD034, no-bare-urls)


## Troubleshooting

### Common Issues

1. **Port Allocation Issues**:

- Ensure Nomad is running with CNI plugins installed
- Check that the network interface is correctly specified
- Verify that ports are not already in use

2. **Container Networking**:

- Ensure Docker is running
- Check that the bridge network is properly configured
- Verify container-to-container communication

3. **Nomad Job Failures**:
- Check Nomad logs for detailed error messages
- Verify that all required images are available
- Ensure resource allocations are sufficient

### Debugging

To debug Nomad issues:

```bash
# View Nomad logs
journalctl -u nomad -f

# Check Nomad status
nomad status

# View specific job details
nomad job status evault-<tenant-id>

# View allocation details
nomad alloc status <allocation-id>
```

## Development

The project uses TypeScript for type safety and better development experience. The source files are in the `src` directory and are compiled to the `dist` directory.

For development, you can use `npm run dev` which uses `tsx` to run the TypeScript files directly without compilation.
27 changes: 27 additions & 0 deletions infrastructure/evault-provisioner/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"name": "evault-provisioner",
"version": "1.0.0",
"description": "API for provisioning evault instances on Nomad",
"main": "dist/index.js",
"type": "module",
"scripts": {
"start": "node dist/index.js",
"dev": "tsx watch src/index.ts",
"build": "tsc",
"test": "vitest"
},
"dependencies": {
"express": "^4.18.2",
"axios": "^1.6.7",
"dotenv": "^16.4.5",
"w3id": "workspace:*"
},
"devDependencies": {
"@types/express": "^4.17.21",
"@types/node": "^20.11.24",
"nodemon": "^3.0.3",
"tsx": "^4.7.1",
"typescript": "^5.3.3",
"vitest": "^1.3.1"
}
}
Loading
Loading