Skip to content
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.

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

Draft: add kubernetes deployment to install docs #1

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions docs/user_guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,47 @@ The Linux release is a standalone [AppImage](https://appimage.org/) executable.

3. Execute the file.

### Kubernetes

The helm chart can be used to install the server components for the shared graph supported by Athens v2.0.0.

1. Add the helm repo (tbd) or clone the helm chart repo.

```bash
git clone https://github.com/mterhar/athens-helm
# helm repo add https://helm.Athensresearch.org # if it gets configured
```

2. Create a `custom-values.yaml` file to configure your deployment.

```yaml
configEdn: "{:password \"makesomethingelsehere\"}"
ingress:
enabled: true
hosts:
- host: athens.mydomain.tld
paths:
- path: /
pathType: ImplementationSpecific
```

Do not enable TLS on the ingress. The client as of 2.0.0-beta.1 does not support TLS.

If you don't have an ingress controller, you can replace the ingress stanza with:

```yaml
service:
type: NodePort
```

3. Install the helm chart with the values

```bash
kubectl create ns athens
helm upgrade -i -n athens athens ./athens-helm -f custom-values.yaml \
--debug --wait --atomic --timeout=5m
```

## Post-installation

### Finding where Athens stores your data
Expand Down