Skip to content

Commit

Permalink
Merge branch 'main' into feat/2019-download-individual-metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
fhennig authored Oct 17, 2024
2 parents 452c7f6 + a04412f commit 0a82cec
Show file tree
Hide file tree
Showing 6 changed files with 557 additions and 502 deletions.
322 changes: 185 additions & 137 deletions docs/package-lock.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.28.2",
"@astrojs/starlight": "^0.28.3",
"@astrojs/starlight-tailwind": "^2.0.3",
"@astrojs/tailwind": "^5.1.1",
"astro": "^4.15.12",
"@astrojs/tailwind": "^5.1.2",
"astro": "^4.16.4",
"prettier": "^3.3.3",
"prettier-plugin-astro": "^0.14.1",
"prettier-plugin-tailwindcss": "^0.6.8",
"sharp": "^0.33.5",
"tailwindcss": "^3.4.13",
"typescript": "^5.6.2"
"typescript": "^5.6.3"
}
}
8 changes: 4 additions & 4 deletions docs/src/content/docs/for-administrators/my-first-loculus.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Let's edit the `custom_values.yaml` file to the following:
```yaml
name: 'Angelovirus DB'
organisms:
asterovirus:
angelovirus:
schema:
organismName: 'Angelovirus'
metadata:
Expand Down Expand Up @@ -194,7 +194,7 @@ ATGGGATTTTGGCATATATATACGA
GCAGAGAGAGATACGTATATATATA
```

Then our metadata file, which we might name `metadata.csv`:
Then our metadata file, which we might name `metadata.tsv`:

```tsv
submissionId city country
Expand All @@ -216,7 +216,7 @@ You can then go to `Submit`. You will be prompted to create a submitting group.
To successfully create a submitting group you will need to be able to access `127.0.0.1` on port `8079` (if you are running this on a remote machine you will need to set up port forwarding for this port too!).
:::

Once you have created a submitting group, you can submit your data. You will need to upload the `sequences.fasta` and `metadata.csv` files. You can then select the organism you created earlier (`Angelovirus`) and submit the data.
Once you have created a submitting group, you can submit your data. You will need to upload the `sequences.fasta` and `metadata.tsv` files. You can then select the organism you created earlier (`Angelovirus`) and submit the data.

You should find that they appear on your Review page and you can choose to release them. If you wait a minute and then refresh the Search page you should find your sequences have appeared! **🎉 We've released the first data for our new database!**

Expand All @@ -230,7 +230,7 @@ When you are done with experimenting, you can delete the cluster with the follow

:::caution

While the pattern that was described in this tuorial is a good way to get started with Loculus, it is not suitable for production use. For a production deployment, you should use a production focused cluster -- either one from a managed service like Vultr, Digital Ocean, AWS, GCP, Azure, or more -- or a self managed cluster, which you can run using [k3s](https://k3s.io/), which is related to k3d.
While the pattern that was described in this tutorial is a good way to get started with Loculus, it is not suitable for production use. For a production deployment, you should use a production focused cluster -- either one from a managed service like Vultr, Digital Ocean, AWS, GCP, Azure, or more -- or a self managed cluster, which you can run using [k3s](https://k3s.io/), which is related to k3d.

Also, for production use you must never run the databases within the Loculus chart, as used here, because these will be wiped whenever the pods are restarted (as we took advantage of above). Instead, you should use a managed database service like AWS RDS, Google Cloud SQL, or Digital Ocean Managed Databases (or you can provision your own database, but **outside** the Loculus chart)

Expand Down
4 changes: 2 additions & 2 deletions kubernetes/loculus/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1451,8 +1451,8 @@ insecureCookies: false
bannerMessage: "This is a demonstration environment. It may contain non-accurate test data and should not be used for real-world applications. Data will be deleted regularly."
additionalHeadHTML: '<script defer data-domain="loculus.org" src="https://plausible.io/js/script.js"></script>'
images:
lapisSilo: "ghcr.io/genspectrum/lapis-silo:0.2.22"
lapis: "ghcr.io/genspectrum/lapis:0.3.4"
lapisSilo: "ghcr.io/genspectrum/lapis-silo:0.2.23"
lapis: "ghcr.io/genspectrum/lapis:0.3.5"
secrets:
smtp-password:
type: raw
Expand Down
Loading

0 comments on commit 0a82cec

Please sign in to comment.