diff --git a/docs/applications/index.md b/docs/applications/index.md deleted file mode 100644 index 0bda76e..0000000 --- a/docs/applications/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: TODO ---- diff --git a/docs/glossary/index.md b/docs/glossary/index.md new file mode 100644 index 0000000..5b1a87b --- /dev/null +++ b/docs/glossary/index.md @@ -0,0 +1,63 @@ +--- +title: Glossary +--- + +## Recipe + +A recipe is what we call the configuration files that are used to deploy an [app](/glossary#app). When you run `abra app deploy `, `abra` is reading a recipe configuration, such as [the gitea recipe](https://git.coopcloud.tech/coop-cloud/gitea), in order to know how to deploy a new Gitea instance. When we speak of a "digital configuraiton commons", we're primarily referring to the [growing collection of recipes](https://git.coopcloud.tech/coop-cloud). + +## App + +An app is a website, tool or otherwise libre software that you use. E.g. Wordpress, Gitea, Jitsi, Nextcloud, etc. + +## Abra + +A command-line tool that has been developed specifically in the context of the Co-op Cloud project for the purpose of making day-to-day operations for [operators](/operators/) and [maintainers](/maintainers/) as convenient as possible. It is libre software, written in [Go](https://go.dev/) and maintained and extended by the community. You can find the source [here](https://git.coopcloud.tech/coop-cloud/abra). + +## Container + +TODO. + +## Stack + +One or more [services](/glossary#service) running together to provide a functionality. An [app](/glossary#app) + +## Docker + +TODO. + +## Service + +A single [Docker](/glossary#docker) [container](/glossary#container) that is a part of a [stack](glossary#stack). + +## Deployment + +The act of assembling a [Docker](glossary#docker) [stack](/glossary#stack) described by a [recipe](/glossary#recipe) configuration. + +## Image + +A template for creating [containers](/glossary#container), describing their file structure and installed binaries. + +## Container + +An instance of an [image](/glossary#image), running processes that are isolated from the host system. + +## Environment variables + +Variables passed from the shell to processes invoked by it. They are used for configuring [services](/glossary#service). + +## The `.env` file + +A file contained in a [recipe](/glossary#recipe) describing the contents of [environmental variables](/glossary#environment-variables). + +## Proxy network + +A virtual network created on the server machine used for communicating between [services](/glossary#service). Any [service](/glossary#service) can be plugged into more than one [network](/glossary#network), allowing for control over data sharing between them. + +## Secret + +[Docker](/glossary#docker) uses those for securely storing data such as passwords. They are stored encrypted on disk and mounted inside the [containers](/glossary#container) as files that can be read that contain the secret. + +## Volume + +A directory that can be mounted inside a [Docker](/glossary#docker) [container](/glossary#container) to store data. Because [containers](/glossary#container) are meant to be non-changeable and disposable, any data that is supposed to not be lost between updates or restarts is stored in volumes. diff --git a/docs/recipes/index.md b/docs/recipes/index.md new file mode 100644 index 0000000..138eae4 --- /dev/null +++ b/docs/recipes/index.md @@ -0,0 +1,15 @@ +--- +title: Recipes +--- + +!!! note "Unsure what a "recipe" is exactly?" + + Not to worry, we've got you covered, check out our [glossary page entry](/glossary#recipe) + +## Recipes catalogue + +The entire recipe catalogue is available on [recipes.coopcloud.tech](https://recipes.coopcloud.tech/). This catalogue is maintained by volunteer [recipe maintainers](/maintainers/). The source for the catalogue is available at [git.coopcloud.tech/recipes.coopcloud.tech](https://git.coopcloud.tech/coop-cloud/recipes.coopcloud.tech). + +## Recipes wishlist + +If you'd like to see a new recipe packaged, make a request on the [recipes-wishlist](https://git.coopcloud.tech/coop-cloud/recipes-wishlist) repository issue tracker. diff --git a/docs/x-archive/glossary.md b/docs/x-archive/glossary.md deleted file mode 100644 index bea760b..0000000 --- a/docs/x-archive/glossary.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: glossary ---- - -abra-related words - -- recipe - a git repository with files describing to abra how to assemble an application -- application - an instance of a recipe composed of one or more services and running as a docker stack -- service - a single docker container that is a part of a stack, configured in compose.yml and .env files -- deployment - the act of assembling a docker stack described by a recipe and application configuration - - -docker-related words: - -- image - a template for creating containers, describing their file structure, installed binaries etc. -- container - an instance of an image, running processes that are isolated from the host system -- environment variables - variables passed from the shell to processes invoked by it. used for configuring services. -- .env file - a file describing the contents of environmental variables -- network - a virtual network created on the server machine used for communicating between services (containers). Any service can be plugged into more than one network, allowing for control over data sharing between them. -- secret - docker uses those for securely storing data such as passwords. They are stored encrypted on disk and mounted inside the containers as files that can be read that contain the secret. -- stack - one or more services (containers) running together to provide a functionality. -- volume - a directory that can be mounted inside a docker container to store data. Because containers are meant to be non-changeable and disposable, any data that is supposed to not be lost between updates or restarts is stored in volumes. - - -"mappings" between those concepts: - -- abra app = docker stack -- abra recipe = set of docker images in `compose` format -- abra service = docker stack service diff --git a/mkdocs.yml b/mkdocs.yml index 8daab22..9bbc4e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,10 +44,11 @@ nav: - "Managed hosting": intro/managed.md - "Get in touch": intro/contact.md - "Operators Guide": operators/index.md - - "Applications": applications/index.md + - "Recipes": recipes/index.md - "Get Involved": get-involved/index.md - "Maintainers Guide": maintainers/index.md - "CLI Reference": cli/index.md + - "Glossary": glossary/index.md plugins: - search