docs: Update tilt documentation
This commit is contained in:
48
README.md
48
README.md
@@ -12,9 +12,10 @@ Oceanbox's comprehensive platform for oceanic data visualization, analysis, and
|
||||
## Bootstrapping Guide
|
||||
|
||||
To bootstrap Atlantis for development, build and run it using Tilt.
|
||||
|
||||
Some setup is required:
|
||||
|
||||
### k8s access
|
||||
### Kubernetes Access
|
||||
|
||||
To run our application on the kubernetes cluster, Tilt needs access.
|
||||
You need to authenticate with `oidc`, using your microsoft account.
|
||||
@@ -45,21 +46,21 @@ Next, configure the required contexts to use `oidc` (also in your `~/.kube/confi
|
||||
```yaml
|
||||
---
|
||||
- context:
|
||||
cluster: ekman
|
||||
namespace: sorcerer
|
||||
user: oidc
|
||||
cluster: ekman
|
||||
namespace: sorcerer
|
||||
user: oidc
|
||||
name: ekman
|
||||
- context:
|
||||
cluster: oceanbox
|
||||
user: oidc
|
||||
cluster: oceanbox
|
||||
namespace: atlantis
|
||||
user: oidc
|
||||
name: oceanbox
|
||||
---
|
||||
```
|
||||
|
||||
Finally, **you must be granted the necessary priveleges in Entra to access the clusters.**
|
||||
Verify that you have access with `kubectl`:
|
||||
|
||||
```sh
|
||||
```shell
|
||||
kubectl --context oceanbox -n default get pods
|
||||
```
|
||||
|
||||
@@ -70,14 +71,13 @@ Clone it into a directory _in the same parent directory as this repository._
|
||||
|
||||
The Bitnami respository must also be added to helm:
|
||||
|
||||
```sh
|
||||
```shell
|
||||
helm repo add bitnami https://charts.bitnami.com/bitnami
|
||||
```
|
||||
|
||||
### DNS
|
||||
|
||||
Some DNS masking is required.
|
||||
Add the following to your NixOS configuration:
|
||||
Some DNS masking is required. Add the following to your NixOS configuration:
|
||||
|
||||
```nix
|
||||
services.dnsmasq = {
|
||||
@@ -113,17 +113,18 @@ Substitute `<...>` for the corresponding secret.
|
||||
|
||||
Now, we should be able to `restore`:
|
||||
|
||||
```sh
|
||||
dotnet tool restore
|
||||
```shell
|
||||
dotnet restore Poseidon.slnx
|
||||
```
|
||||
|
||||
for `dotnet-tools` we use nix, so entering the shell using `nix-shell` or `direnv` is enough.
|
||||
|
||||
### Mkcert
|
||||
|
||||
To generate certificates correctly, vite needs the `mkcert` binary in a predefined path in our home directory.
|
||||
`mkcert` is included in our dev shell, so we can create a symlink to its location in the nix store:
|
||||
|
||||
```sh
|
||||
```fish
|
||||
which mkcert | xargs -I{} ln -s {} ~/.vite-plugin-mkcert
|
||||
```
|
||||
|
||||
@@ -132,12 +133,16 @@ which mkcert | xargs -I{} ln -s {} ~/.vite-plugin-mkcert
|
||||
### Docker Login
|
||||
|
||||
In order for Tilt to push the images it builds to the oceanbox registry, we must use `docker login` to authenticate with it.
|
||||
First, create a personal access token in your gitlab account.
|
||||
It should have the `read_registry` and `write_registry` scopes set.
|
||||
First, create a personal access token in your gitlab account. It should have the `read_registry` and `write_registry` scopes set.
|
||||
|
||||
```fish
|
||||
set -x TOKEN glpat-xxxx
|
||||
```
|
||||
|
||||
Then, supply it to `docker login`:
|
||||
|
||||
```sh
|
||||
docker login registry.gitlab.com/oceanbox
|
||||
```shell
|
||||
echo "$TOKEN" | docker login gitlab.com -u <user> --password-stdin
|
||||
```
|
||||
|
||||
When prompted, authenticate with your gitlab username and the PAT you just created.
|
||||
@@ -146,7 +151,7 @@ When prompted, authenticate with your gitlab username and the PAT you just creat
|
||||
|
||||
A namespace must be created for your tilt application to live in on the cluster.
|
||||
|
||||
```sh
|
||||
```shell
|
||||
kubectl create ns "$APP_NAMESPACE" --context oceanbox
|
||||
```
|
||||
|
||||
@@ -154,7 +159,7 @@ kubectl create ns "$APP_NAMESPACE" --context oceanbox
|
||||
|
||||
In the project root, run tilt with the following command:
|
||||
|
||||
```sh
|
||||
```shell
|
||||
tilt up --context oceanbox
|
||||
```
|
||||
|
||||
@@ -175,4 +180,5 @@ Ask [sales](moritz.jorg@oceanbox.io) to add your `azure-ad-user` to OpenFGA.
|
||||
|
||||
### CORS for Sorcerer
|
||||
|
||||
Add the `url` of your instance to the CORS list of Sorcerer [here](https://gitlab.com/oceanbox/manifests/-/blob/main/values/sorcerer/kustomize/prod/appsettings.json?ref_type=heads#L52).
|
||||
Add the `url` of your instance to the CORS list of Sorcerer
|
||||
[here](https://gitlab.com/oceanbox/manifests/-/blob/main/values/sorcerer/kustomize/prod/appsettings.json?ref_type=heads#L52).
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Development helper scripts.
|
||||
|
||||
```
|
||||
```shell
|
||||
├── update-deps.sh
|
||||
│ └─ Updates dependencies for the Poseidon project, including both .NET and npm.
|
||||
├── configure-manifests.sh
|
||||
|
||||
Reference in New Issue
Block a user