Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gpelouze committed Oct 24, 2023
1 parent b58563c commit a3ff2d6
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Checkout the [Git Submodules documentation](https://git-scm.com/book/en/v2/Git-T

### Conda environment

Install Anaconda from these instructions: https://linuxize.com/post/how-to-install-anaconda-on-ubuntu-20-04/
Install Conda from these instructions: https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html

Setup a new conda environment and install dependencies:

```shell
conda create --name naavre-dev
conda activate naavre-dev
conda install -c conda-forge pre_commit minikube tilt
conda install -c conda-forge pre_commit minikube kubernetes-helm tilt
```

### Pre-commit hooks
Expand All @@ -40,7 +40,36 @@ ggshield auth login

### Minikube cluster

The NaaVRE components are deployed by tilt to a local Kubernetes using minikube. We use ingress-dns to access those resources. To configure it, follow step 3 section of the [minikube ingress-dns setup guide](https://minikube.sigs.k8s.io/docs/handbook/addons/ingress-dns/). Chose your operating system. For most linux distributions, follow the section “Linux OS with Network Manager”.
The NaaVRE components are deployed by tilt to a local Kubernetes using minikube. We use ingress-dns to access those resources. To configure it, follow step 3 section of the [minikube ingress-dns setup guide](https://minikube.sigs.k8s.io/docs/handbook/addons/ingress-dns/). Chose your operating system.

<details open>

<summary>For Linux, pick the configuration matching your DNS setup (expand to read more)</summary>

To find the DNS setup, run `head /etc/resolv.conf`:

- Mentions resolvconf: follow the [Linux OS with resolvconf](https://minikube.sigs.k8s.io/docs/handbook/addons/ingress-dns/#linux-os-with-resolvconf) instructions
- Contains `# Generated by NetworkManager`: follow the [Linux OS with Network Manager](https://minikube.sigs.k8s.io/docs/handbook/addons/ingress-dns/#linux-os-with-network-manager) instructions
- Contains `# This is /run/systemd/resolve/stub-resolv.conf managed by man:systemd-resolved(8).`: run the following commands (systemd-resolved is not covered by the minikube documentation):
```shell
sudo mkdir /etc/systemd/resolved.conf.d
sudo tee /etc/systemd/resolved.conf.d/minikube.conf << EOF
[Resolve]
DNS=$(minikube ip)
Domains=~test
EOF
sudo systemctl restart systemd-resolved
```
</details>
### Helm dependencies
During the initial setup, and after updating `submodules/VREPaaS-helm-charts`, run:
```shell
helm dependency build submodules/VREPaaS-helm-charts
```
## Run the dev environment
Expand Down

0 comments on commit a3ff2d6

Please sign in to comment.