First version of VRE integrated chart #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: Skaffold | ||
| on: | ||
| push: | ||
| paths: | ||
| - src/** | ||
| - .github/workflows/ci.yml | ||
| - action.yml | ||
| jobs: | ||
| pipeline: | ||
| name: Skaffold Pipeline | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - name: Checkout sources | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Setup Minikube | ||
| uses: hiberbee/[email protected] | ||
|
|
||
| - name: Setup Helm | ||
| uses: hiberbee/[email protected] | ||
| with: | ||
| repository-config: test/repositories.yaml | ||
|
|
||
| # - name: Login to Docker Hub | ||
| # uses: docker/login-action@v1 | ||
| # with: | ||
| # registry: ${{ secrets.DOCKER_REGISTRY }} | ||
| # username: ${{ secrets.DOCKER_USERNAME }} | ||
| # password: ${{ secrets.DOCKER_PASSWORD }} | ||
|
|
||
| - name: Run Skaffold pipeline as action | ||
| uses: hiberbee/[email protected] | ||
| with: | ||
| command: run | ||
| repository: ghcr.io/${{ github.repository }} | ||
|
|
||
| - name: Get Helm releases | ||
| run: helm list |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| vre/Chart.lock | ||
| vre/charts | ||
| vre/values-custom.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| repos: | ||
| - repo: https://github.com/codespell-project/codespell | ||
| rev: v2.3.0 | ||
| hooks: | ||
| - id: codespell | ||
| additional_dependencies: | ||
| - tomli | ||
|
|
||
| - repo: https://github.com/norwoodj/helm-docs | ||
| rev: "v1.14.2" | ||
| hooks: | ||
| - id: helm-docs-built | ||
| args: | ||
| - "--chart-search-root=./vre" | ||
|
|
||
| #TODO: add kubeconform |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| up: | ||
| skaffold run | ||
|
|
||
| create-cluster: | ||
| kind create cluster --config=dev/kind-config.yaml | ||
|
|
||
|
|
||
| ingress: | ||
| kubectl apply -f https://kind.sigs.k8s.io/examples/ingress/deploy-ingress-nginx.yaml | ||
| kubectl wait --namespace ingress-nginx \ | ||
| --for=condition=ready pod \ | ||
| --selector=app.kubernetes.io/component=controller \ | ||
| --timeout=90s | ||
|
|
||
| .PHONY: create-cluster ingress |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,49 @@ | ||
| # VRE Helm charts repository | ||
|
|
||
| ## Testing locally | ||
|
|
||
|
|
||
| ### Setting up cluster | ||
|
|
||
|
|
||
| #### Create a cluster | ||
|
|
||
| We recommend using [kind](https://kind.sigs.k8s.io/) to test the charts locally. Chart operations are done using [Skaffold](https://skaffold.dev/): | ||
|
|
||
| ``` | ||
| $ kind create cluster --config dev/kind-config.yaml | ||
| ``` | ||
|
|
||
| #### Install an ingress controller | ||
|
|
||
| The easiest and production-like way to access local VRE deployment is by installing a simple ingress controller. Production clusters will almost always have only already included. | ||
|
|
||
| ``` | ||
| $ kubectl apply -f https://kind.sigs.k8s.io/examples/ingress/deploy-ingress-nginx.yaml | ||
| ``` | ||
|
|
||
| #### Customize local values | ||
|
|
||
| Even in a local cluster, you may want to use a real IAM instance. To do that, you will need to customize some secret values. You can do it by copying provided example: | ||
|
|
||
| ``` | ||
| $ cp vre/values-custom-example.yaml vre/values-custom.yaml | ||
| ``` | ||
|
|
||
| #### Deploy VRE | ||
|
|
||
| ``` | ||
| $ skaffold run | ||
| ``` | ||
|
|
||
|
|
||
| ## Configuration | ||
|
|
||
| For complete list of helm chart values, see chart [doc](vre/README.md). These values give a lot of flexibility allow to customize the chart. | ||
|
|
||
| Some values almost certainly need to be set in every particular deployment. These values are provided in [vre/values-custom.yaml](vre/values-custom-example.yaml). | ||
|
|
||
| ## Known issues | ||
|
|
||
| * rucio token expires before login to jupyterlab. It means that sometimes it is possible to access jupyterhub but not start session (which relies on token exchange). If you find yourself in this situation, try to relogin to jupyterhub, it is likely to fix the issue. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| add kind cluster | ||
|
|
||
|
|
||
| sync db from postgres | ||
|
|
||
| to postinstall: | ||
|
|
||
| ./scripts/create-admin-user.sh etap cern-vre [email protected] tsdasdasd | ||
|
|
||
| set vre-admin-access-token | ||
|
|
||
| rucio token expires before auth is gone. need to renew it |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| kind: Cluster | ||
| apiVersion: kind.x-k8s.io/v1alpha4 | ||
| nodes: | ||
| - role: control-plane | ||
| extraPortMappings: | ||
| - containerPort: 80 | ||
| hostPort: 80 | ||
| protocol: TCP | ||
| - containerPort: 443 | ||
| hostPort: 443 | ||
| protocol: TCP |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,14 @@ | ||||||
| apiVersion: skaffold/v4beta12 | ||||||
| kind: Config | ||||||
| metadata: | ||||||
| name: cern-vre | ||||||
| deploy: | ||||||
| helm: | ||||||
| releases: | ||||||
| - name: cern-vre | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| chartPath: vre | ||||||
| valuesFiles: | ||||||
| - vre/values.yaml | ||||||
| # copy vre/values-custom-copy.yaml to vre/values-custom.yaml, set the necessary values, and uncomment this line | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - vre/values-custom.yaml | ||||||
| version: 0.1.0-dev0 | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| values-custom.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| apiVersion: v2 | ||
| name: cern-vre | ||
| version: 0.1.0-dev23 | ||
| description: The Virtual Research Environment developed at CERN.> | ||
| keywords: | ||
| - jupyterhub | ||
| - rucio | ||
| - reana | ||
| home: https://vre-hub.github.io | ||
| sources: | ||
| - https://github.com/vre-hub/vre | ||
|
|
||
| dependencies: | ||
| - name: jupyterhub | ||
| version: 3.3.7 | ||
| repository: https://hub.jupyter.org/helm-chart | ||
| condition: jupyterhub.enabled | ||
|
|
||
| - name: reana | ||
| #version: 0.95.0-alpha.2-6-g970d4b7 | ||
| #version: 0.95.0-alpha.2 | ||
| #version: 0.9.4 | ||
| version: 0.9.4-1-gcd7dcb3 | ||
| repository: https://volodymyrss.github.io/reana | ||
| #repository: https://reanahub.github.io/reana | ||
| condition: reana.enabled | ||
|
|
||
| - name: nfs-server-provisioner | ||
| condition: nfs-server-provisioner.enabled | ||
| version: 1.8.0 | ||
| repository: https://kubernetes-sigs.github.io/nfs-ganesha-server-and-external-provisioner | ||
|
|
||
| # TODO: add prometheus and grafana | ||
|
|
||
| - name: grafana | ||
| condition: grafana.enabled | ||
| version: 9.2.2 | ||
| repository: https://grafana.github.io/helm-charts | ||
|
|
||
| - name: prometheus | ||
| condition: prometheus.enabled | ||
| version: 27.20.0 | ||
| repository: https://prometheus-community.github.io/helm-charts | ||
|
|
||
| - name: loki | ||
| condition: loki.enabled | ||
| version: 6.30.1 | ||
| repository: https://grafana.github.io/helm-charts | ||
|
|
||
| - name: fluent-bit | ||
| version: 0.48.9 | ||
| condition: fluent-bit.enabled | ||
| repository: https://fluent.github.io/helm-charts | ||
|
|
||
| # TODO: eventually add an integrated rucio chart, https://github.com/rucio/helm-charts/pull/217 | ||
| # - name: rucio | ||
| # version: | ||
| # repository: | ||
| # condition: rucio.enabled | ||
| # | ||
| # | ||
|
|
||
|
|
||
| maintainers: | ||
| - name: The maintainer name (required for each maintainer) | ||
| email: [email protected] | ||
| url: A URL for the maintainer (optional for each maintainer) | ||
|
|
||
| icon: https://vre-hub.github.io/img/favicon.ico | ||
| appVersion: 0.1.0 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe "escape-vre" is better, or even "my-escape-vre" as a default release name. Whatever this thing is, it won't actually be the CERN VRE :)
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, interesting question.
For me, "VRE" is a generic term which I see throughout the related domains. So I assumed that name of the software product is "CERN VRE". Since it is a particular kind of a Virtual Research Environment, the kind made by CERN. See also the logo:
It also coincides with the name of the CERN instance.
However, we have now ESCAPE VRE, CERN VRE, ETAP VRE, and I wonder.
@garciagenrique @Soap2G what do you think? Should "CERN" be anywhere in the name of the generic VRE chart?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for raising this point.
IMO, each VRE deployment should keep their institution or "brand". In the way I imagine things, we should aim for a common "helm base layer" (let's call it vre or escape-vre). Then, each of the specific installations (CERN, ET, etc) could name their respective inherited chart as they want :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With respect to the logo @Soap2G was the master mind behind the design. If you like it, we can create an ET VRE one, or feel free to create one based on the cern-vre one :)