docs.coopcloud.tech/docs/faq.md

254 lines
15 KiB
Markdown
Raw Normal View History

2021-01-02 13:13:54 +00:00
---
2021-02-18 11:20:30 +00:00
title: Frequently asked questions
2021-01-02 13:13:54 +00:00
---
2021-02-23 16:41:47 +00:00
## What is the Co-op Cloud?
2021-01-02 13:13:54 +00:00
Co-op Cloud aims to make hosting libre software apps simple for small service providers such as tech co-operatives who are looking to standardise around an open, transparent and scalable infrastructure. It uses the latest container technologies and configurations are shared into [the commons](https://en.wikipedia.org/wiki/Commons) for the benefit of all.
2021-02-18 11:20:30 +00:00
2021-02-23 16:41:47 +00:00
## Who is behind the project?
2021-02-18 11:20:30 +00:00
2021-03-12 10:52:49 +00:00
The project was started by workers at [Autonomic](https://autonomic.zone/) which is a [worker-owned co-operative](https://en.wikipedia.org/wiki/Worker_cooperative). We provide technologies and infrastructure to empower users to make a positive impact on the world. We're using Co-op Cloud in production, amongst other systems.
2021-02-18 11:20:30 +00:00
2021-02-23 16:41:47 +00:00
## Why Co-op Cloud?
2021-02-23 14:13:12 +00:00
2021-02-23 16:41:47 +00:00
#### 👍
2021-02-23 20:46:32 +00:00
2021-02-23 16:41:47 +00:00
- 👍 Thin "ease of use" layer on top of already standardised tooling
- 👍 Extremely modular
- 👍 Collective commons based configuration via public git repos
- 👍 Focussed on hosting providers
2021-02-23 20:55:29 +00:00
- 👍 Uses upstream published containers (no duplication on packaging)
- 👍 Now and always libre software
2021-02-23 16:41:47 +00:00
- 👍 Command line focussed
- 👍 Horizontal and vertical scaling
2021-02-18 11:20:30 +00:00
2021-02-23 16:41:47 +00:00
#### 👎
2021-02-23 20:46:32 +00:00
2021-02-23 16:41:47 +00:00
- 👎 Still a very young project
- 👎 Limited availability of well tested apps
- 👎 Requires command line knowledge to use
2021-07-05 14:02:40 +00:00
- 👎 Currently x86 only (see [this FAQ question](#why-only-x86-support) for more)
2021-02-18 11:20:30 +00:00
## Why start another project?
2021-03-01 12:12:01 +00:00
Please read our [initial project announcement post](https://autonomic.zone/blog/co-op-cloud/) for more on this.
2021-02-18 11:20:30 +00:00
2021-05-31 20:30:04 +00:00
Also see our [strategy page](/strategy/).
2021-05-31 20:01:25 +00:00
## How do I package an app?
See [the packager guide documentation](/packager-guide/#package-your-first-application) for more.
2021-02-18 11:20:30 +00:00
## What about `$alternative`?
2021-03-14 14:24:58 +00:00
We have various technical critiques of other similar projects which are already up-and-running in the ecosystem, as they don't necessarily meet our needs as a small tech co-op. However, Co-op Cloud isn't meant to be a replacement for these other projects.
2021-03-12 10:52:49 +00:00
2021-03-20 21:52:53 +00:00
Here is a short overview of the pros/cons we see, in relation to our goals and needs.
2021-01-02 13:13:54 +00:00
### Cloudron
2021-02-18 11:20:30 +00:00
#### 👍
- 👍 Decent web interface for app, domain & user management.
- 👍 Large library of apps.
- 👍 Built-in SSO using LDAP, which is compatible with more apps and often has a better user interface than OAuth.
- 👍 apps are actively maintained by the Cloudron team.
2021-02-18 11:20:30 +00:00
#### 👎
2021-02-23 16:41:47 +00:00
- 👎 Moving away from open source. The core is now proprietary software.
- 👎 libre tier has a single app limit.
- 👎 Based on Docker images, not stacks, so multi-process apps (e.g. parsoid visual editor for Mediawiki) are a non-starter.
- 👎 Difficult to extend apps.
2021-02-23 16:41:47 +00:00
- 👎 Only supported on Ubuntu LTS.
2021-02-23 20:55:29 +00:00
- 👎 Upstreams libre software communities aren't involved in packaging.
2021-02-23 16:41:47 +00:00
- 👎 Limited to vertical scaling.
- 👎 Tension between needs of hosting provider and non-technical user.
2021-03-12 10:52:49 +00:00
- 👎 LDAP introduces security problems - one vulnerable app can expose a user's password for all apps.
2021-02-23 16:41:47 +00:00
- 👎 Bit of a [black box](https://en.wikipedia.org/wiki/Black_box).
2021-01-02 13:13:54 +00:00
### YunoHost
2021-02-18 11:20:30 +00:00
#### 👍
- 👍 Lovely web interface for app, domain & user management.
- 👍 Bigger library of apps.
2021-02-23 16:41:47 +00:00
- 👍 Awesome backup / deploy / restore continuous integration testing.
- 👍 Supports hosting apps in subdirectories as well as subdomains.
2021-02-23 16:41:47 +00:00
- 👍 Doesn't require a public-facing IP.
2021-03-01 11:40:39 +00:00
- 👍 Supports system-wide mutualisation of resources for apps (e.g. sharing databases by default)
2021-02-18 11:20:30 +00:00
#### 👎
2021-02-23 20:55:29 +00:00
- 👎 Upstream libre software communities aren't involved in packaging.
- 👎 Uninstalling apps leaves growing cruft.
2021-02-23 16:41:47 +00:00
- 👎 Limited to vertical scaling.
- 👎 Not intended for use by hosting providers.
2021-03-14 14:24:58 +00:00
2021-03-12 10:52:49 +00:00
### Caprover
#### 👍
- 👍 Bigger library of apps.
2021-03-12 10:52:49 +00:00
- 👍 Easy set-up using a DigitalOcean one-click app.
- 👍 Works without a domain name or a public IP, in non-HTTPS mode (good for homeservers).
- 👍 Deploy any app with a `docker-compose.yml` file as a "One Click App" via the web interface.
- 👍 Multi-node (multi-server) set-up works by default.
#### 👎
- 👎 Single-file app definition format, difficult to tweak using entrypoint scripts.
- 👎 Nginx instead of Traefik for load-balancing.
- 👎 Command-line client requires NodeJS / `npm`.
- 👎 [Requires 512MB RAM for a single app](https://github.com/caprover/caprover/issues/28).
- 👎 [Backup/restore is "experimental"](https://caprover.com/docs/backup-and-restore.html), and doesn't currently help with backing up Docker volumes.
- 👎 Exposes its bespoke management interface to the internet via HTTPS by default.
2021-01-02 13:13:54 +00:00
### Ansible
2021-02-18 11:20:30 +00:00
#### 👍
2021-02-23 16:41:47 +00:00
- 👍 Includes server creation and bootstrapping.
2021-02-18 11:20:30 +00:00
#### 👎
2021-02-23 20:46:32 +00:00
- 👎 Upstream libre software communities aren't publishing Ansible roles
- 👎 Lots of manual work involved in things like app isolation, backups, updates
2021-01-02 13:13:54 +00:00
### Kubernetes
2021-02-18 11:20:30 +00:00
#### 👍
2021-02-23 20:46:32 +00:00
- 👍 Helm charts are available for some key apps already.
2021-02-23 16:41:47 +00:00
- 👍 Scale all the things.
2021-02-18 11:20:30 +00:00
#### 👎
2021-02-23 16:41:47 +00:00
- 👎 Too big -- requires 3rd party tools to run a single-node instance.
- 👎 Not suitable for a small to mid size hosting provider.
2021-01-02 13:13:54 +00:00
### Docker-compose
2021-02-18 11:20:30 +00:00
#### 👎
2021-02-23 16:41:47 +00:00
- 👎 Manual work required for process monitoring.
- 👎 Secret storage not available yet.
- 👎 [Swarm is the new best practice](https://github.com/BretFisher/ama/issues/8#issuecomment-367575011).
2021-01-02 13:13:54 +00:00
2021-02-23 16:41:47 +00:00
### Doing it Manually (Old School)
2021-01-02 13:13:54 +00:00
2021-02-18 11:20:30 +00:00
#### 👍
2021-02-23 16:41:47 +00:00
- 👍 Simple - just follow upstream instructions to install and update.
2021-02-18 11:20:30 +00:00
#### 👎
- 👎 Loads of manual work required for app isolation and backups.
- 👎 Array of sysadmin skills required to install and maintain apps.
2021-02-23 16:41:47 +00:00
- 👎 Hard to share configurations into the commons.
- 👎 No idea who has done what change when.
## Which technologies are used?
2021-02-23 20:46:32 +00:00
The core technologies of Co-op Cloud are libre software and enjoy wide adoption across software developer communities.
2021-02-23 16:41:47 +00:00
2021-02-23 20:46:32 +00:00
- [Containers](#why-containers)
- [Compose specification](#why-docker-compose)
- [Docker swarm](#why-docker-swarm)
- [Abra command-line tool](https://git.autonomic.zone/coop-cloud/abra)
2021-02-23 16:41:47 +00:00
2021-02-23 20:46:32 +00:00
## Why containers?
2021-02-23 16:41:47 +00:00
2021-03-20 21:52:53 +00:00
We use containers because so many libre software communities choose to use them. They are already writing and using Docker files and Docker-compose definitions for their development and production environments.
2021-03-10 15:57:25 +00:00
2021-03-20 21:52:53 +00:00
We can directly re-use this good packaging work and contribute back by helping maintain their in-repository files. We meet them where they are at and do not create a new packaging format or duplicate effort.
2021-03-10 15:57:25 +00:00
2021-03-20 21:52:53 +00:00
Co-op cloud proposes the idea of more direct coordination between distribution (app packagers) and production (developers) methods.
2021-02-23 16:41:47 +00:00
2021-03-10 15:58:52 +00:00
## Aren't containers horrible from a security perspective?
2021-03-10 15:57:48 +00:00
It depends, just like any other technology and understanding of security. Yes, we've watched [that CCC talk](https://media.ccc.de/v/rc3-49321-devops_disasters_3_1).
2021-03-10 15:58:52 +00:00
It's on us all as the libre software community to deliver secure software and we think one of the promises of Co-op Cloud is better cooperation with developers of the software (who favour containers as a publishing format) and packagers and hosters (who deliver the software to the end-user).
2021-03-10 15:57:48 +00:00
This means that we can patch our app containers directly in conversation with upstream app developers and work towards a culture of security around containers.
2021-03-10 15:58:52 +00:00
We definitely recommend using best-in-class security auditing tools like [docker-bench-security](https://github.com/docker/docker-bench-security), IDS systems like [OSSEC](https://www.ossec.net/), security profiles like [Apparmor](https://docs.docker.com/engine/security/apparmor/) and hooking these into your existing monitoring, alert and update maintenance flows.
It's up to how you want to arrange your system. For example, Co-op Cloud also allows you to compartmentalise different apps onto different servers. You could stack a bunch of apps on one big server or you could deploy one app per server.
2021-03-10 15:58:52 +00:00
These are organisational concerns that Co-op Cloud can't solve for you which any software system will require. See this [additional question](/faq/#what-is-important-to-consider-when-running-containers-in-production) for further information.
2021-03-10 15:57:48 +00:00
## What is important to consider when running containers in production?
2021-03-10 16:01:08 +00:00
The Co-op Cloud uses [containers](/faq/#why-containers) as a fundamental building block. Therefore it is important to be aware of some general principles for container management in production environments. These are typically things that you will want to discuss within your co-op or democratic collective about how to prioritise and build up process for.
However, as the Co-op Cloud project is still very young, we're also still thinking about how we can make the platform itself mitigate problematic issues and make the maintenance of containers a more stable experience.
2021-03-10 15:57:48 +00:00
With that all in mind, here are some leading thoughts.
- How do you install the Docker daemon itself on your systems and how do you manage upgrades? (system package, upstream Docker Inc. repository?)
- How do you secure the Docker daemon from remote access (firewalls and system access controls).
- How do you secure the Docker daemon socket within the swarm (locking the socket down, using things like a [socket proxy](https://github.com/Tecnativa/docker-socket-proxy))
- How do you trust the upstream container registry (there are [content trust mechanisms](https://docs.docker.com/engine/security/trust/) but it seems also useful to think about whether we need community registry infrastructure using tools like [harbor](https://goharbor.io/) or [distribution](https://github.com/distribution/distribution). This involves a broader discussion with upstream communities.)
- How do I audit my container security in an on-going process (IDS, OSSEC, Apparmor, etc.)
- Can I run my containers with a [non-root user setup](https://docs.docker.com/engine/security/rootless/)?
2021-03-10 23:19:18 +00:00
And further reading on this topic:
- [Docker security documentation](https://docs.docker.com/engine/security/)
2021-03-14 14:22:25 +00:00
- [OWASP Docker Security Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Docker_Security_Cheat_Sheet.html)
2021-03-10 23:19:18 +00:00
2021-03-10 15:16:48 +00:00
## Why use the Compose specification?
2021-02-23 16:41:47 +00:00
Every app packaged for the Co-op Cloud is described using a file format which uses the [compose specification](https://compose-spec.io/). It is important to note that we do not use the [Docker compose](https://docs.docker.com/compose/) tool itself to deploy apps using this format, instead we rely on [Docker swarm](https://docs.docker.com/engine/swarm/stack-deploy/).
2021-03-10 15:57:25 +00:00
The compose specification is a useful open standard for specifying libre software app deployments in one file. It appears to be the most accessible format for describing apps and this can be seen in the existence of tools like [Kompose](https://kompose.io/) where the compose format is used as the day-to-day developer workflow format which is then translated into more complicated formats for deployment.
We are happy to see the compose specification emerging as a new open standard because that means we don't have to rely on Docker Inc. in the future - there will be more community tools available.
2021-02-23 16:41:47 +00:00
2021-02-23 20:46:32 +00:00
## Why Docker Swarm?
2021-02-23 16:41:47 +00:00
While many have noted that "swarm is dead" it is in fact [not dead](https://www.mirantis.com/blog/mirantis-will-continue-to-support-and-develop-docker-swarm/). As detailed in the [architecture overview page](/overview/#container-orchestrator), swarm offers an appropriate feature set which allows us to support zero-down time upgrades, seamless app rollbacks, automatic deploy failure handling, scaling, hybrid cloud setups and maintain a decentralised design.
2021-03-10 15:57:25 +00:00
While the industry is bordering on a [k8s](https://kubernetes.io/) obsession and the need to [scale down](https://microk8s.io/) a tool that was fundamentally built for massive scale, we are going with swarm because it is the tool most suitable for [small technology](https://small-tech.org/).
We hope to see a container orchestrator tool that is not directly linked to a for-profit company emerge soon but for now, this is what we have.
2021-02-23 16:41:47 +00:00
2021-03-18 12:20:17 +00:00
If you want to learn more, see [dockerswarm.rocks](https://dockerswarm.rocks/) for a nice guide.
2021-02-23 16:15:41 +00:00
## What licensing model do you use?
2021-02-23 20:46:32 +00:00
2021-02-23 20:48:01 +00:00
The Co-op Cloud is and will always be available under [copyleft licenses](https://en.wikipedia.org/wiki/Copyleft).
2021-03-01 10:23:28 +00:00
2021-03-20 21:52:53 +00:00
We're discussing more specifics on [this issue](https://git.autonomic.zone/coop-cloud/organising/issues/50) if you'd like to see the on-going conversation.
2021-03-01 11:34:47 +00:00
## Isn't running everything in containers inefficient?
2021-03-01 10:23:28 +00:00
It is true that if you install 3 apps and each one requires a MySQL database, then you will have 3 installations of MySQL on your system, running in containers.
2021-03-10 15:57:25 +00:00
Systems like [YunoHost](/faq/#yunohost) mutualise every part of the system for maximum resource efficiency - if there is a MySQL instance available on the system, then just make a new database there and share the MySQL instance instead of creating more.
However, as we see it, this creates a tight coupling between apps on the database level - running a migration on one app where you need to turn the database off takes down the other apps.
2021-03-10 15:57:25 +00:00
It's a balance, of course. In this project, we think that running multiple databases and maintaining more strict app isolation is worth the hit in resource efficiency.
2021-03-10 15:57:25 +00:00
It is easier to maintain and migrate going forward in relation to other apps and problems with apps typically have a smaller problem space - you know another app is not interfering with it because there is no interdependency.
2021-03-10 15:57:25 +00:00
It can also pay off when dealing with GDPR related issues and the need to have more stricter data layer separation.
2021-05-02 18:08:35 +00:00
## How do I keep up-to-date with Docker Swarm developments?
2021-05-02 18:09:19 +00:00
- [Official release changelog for Docker Engine (look for entries under the "Swarm" header)](https://docs.docker.com/engine/release-notes/)
2021-05-02 18:08:35 +00:00
- [All issues raised with label `area/swarm` label on github.com/moby/moby](https://github.com/moby/moby/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fswarm)
- [All pull requests submitted with the `area/swarm` label on github.com/moby/moby](https://github.com/moby/moby/pulls?q=is%3Aopen+is%3Apr+label%3Aarea%2Fswarm)
## Can I run Co-op Cloud on multiple servers?
Yes! Horizontal scaling is one of the ways Co-op Cloud can really shine. `abra` is designed to handle multiple servers from the first day. As long as you have a DNS entry pointing to your server then Co-op Cloud can serve apps (e.g. you can serve a `wordpress1.mydomain.com` from one server and a `wordpress2.mydomain.com` from another server) and `abra` handles this seamlessly.
2021-07-05 14:02:40 +00:00
## Why only x86 support?
2021-07-05 14:08:24 +00:00
We would love to do ARM support and hope to get there! We've been testing this and [ran into some issues](https://git.autonomic.zone/coop-cloud/organising/issues/25). The TLDR; is that a lot of upstream libre app developer communities are not publishing container builds that support ARM. If they are, there are typically subtle differences in the conventions used to build the image as they are mostly done by community members and not directly taken on by the upstream project themselves. Since one of the core goals is to coordinate and reuse upstream packaging work, we see that ARM support requires a lot of organising and community engagement. Perhaps projects themselves will not want to take on this burden? It is not the role of the Co-op Cloud to set up an entire ARM publishing work flow at this moment in time. We see the benefits of supporting ARM and if you've got ideas / thoughts / approaches for how to make progress here, [please get in touch](https://docs.coopcloud.tech/contact/).