Documentation should describe supported/non-supported use cases

[olljanat]

Currently it is still bit unclear that which use case will be supported by BurmillaOS and key driver to define scope is feedback given on #6

However I think that we can say for sure that:

These use cases are not supported:

• Kubernetes/K3s (because k3OS is made for those use cases)
• Rancher 2.x (because we do not support Kubernetes)
• Other Kubernetes specific tools

These use cases are supported:

• Standalone Docker containers (docker run / docker create)
• Multi-container Docker applications (docker-compose)
• Docker Swarm mode (docker stack deploy / docker service)

Also it is worth to mention that with "not supported" I mean that users are free to use BurmillaOS for those use cases if that works but any issues related to those will be considered to be on low priority.

[olljanat]

@tomaswarynyca @ToeiRei comments?

[ToeiRei]

Kubernetes is 'just a bunch of containers' and nothing we should really be scared of. I just wouldn't mention it as it doesn't need any special stuff (btw, I run K3s on rancherOS)

[olljanat]

Kubernetes is 'just a bunch of containers' and nothing we should really be scared of.

On simple configuration yes but when it comes more complex setup there will be need to be persistent storage for /var/lib/kubelet and example Longhorn needs iscsid (look #21).

(btw, I run K3s on rancherOS)

OK but notice that Rancher team made it very clear that they will not support K3s on RancherOS k3s-io/k3s#173 (comment) Obviously they did know already then that RancherOS will be discontinued.

I just wouldn't mention it as it doesn't need any special stuff

Maybe we should then at least try explain recommend/tested use cases/configurations on documentation? Also BurmillaOS + K3s might make sense (on theory) on some specific use cases like on Raspberry Pi if k3OS will not support it but IMO we should not compete with k3OS on use cases which it can handle.

[ToeiRei]

Maybe we should then at least try explain recommend/tested use cases/configurations on documentation?

maybe something like 'We use it for.... ' to narrow it down a bit.
'We do not support...' or 'You must not...' are phrasings I'd like to avoid.

[olljanat]

'We do not support...' or 'You must not...' are phrasings I'd like to avoid.

Good point but we still should take care of the fact that BurmillaOS is based on Docker and now Kubernetes team is deprecating Docker support https://www.theregister.com/AMP/2020/12/03/docker_deprecated_in_kubernetes_this/

[tomaswarynyca]

Describe supported/non-supported use cases

It seems correct to me to define the course of BurmillaOS. For the moment you should focus on the docker environment.
Support to @olljanat that in the documentation it is necessary to define well for which use BurmillaOS is focused.

Kubernetes is 'just a bunch of containers' and nothing we should really be scared of.

At the moment I don't see the need to put support for Kubernetes so he said @olljanat will no longer support Docker as they
are moving to ContainerD.

(btw, I run K3s on rancherOS)

If you like @ToeiRei you can make a guide of how to use k3s in BurmillaOS but officially it's not a good idea to support it.

[ToeiRei]

As docker support is now obsolete in kubernetes, we'can safely ignore that :)

[dgiebert]

As far as I understood RancherOS and therefore also BurmillaOS is built using Moby which uses containerd. You can verify this using:

ctr -n moby -a /run/docker/containerd/containerd.sock containers ls

I will keep an eye on this and make it work for Kubernetes if desired ?

[olljanat]

As far as I understood RancherOS and therefore also BurmillaOS is built using Moby which uses containerd.

True so as long user Docker/Moby comes with supported containerd version it might works (on theory).
You can check containerd version with command:

sudo ctr -n moby -a /run/docker/containerd/containerd.sock version

I also quickly checked that it updates if I switch to later Docker versions burmilla/os-services#7

I will keep an eye on this and make it work for Kubernetes if desired ?

Works for me as long it does not require big changes to BurmillaOS.

[laghoule]

Running K8S on RancherOS 1.5.6, installed via RKE.
Ceph kernel module loaded

[olljanat]

FYI. Looks that Rancher have released tool called for k3d which looks to be nice way to play with k3s on BurmillaOS: https://rancher.com/blog/2020/set-up-k3s-high-availability-using-k3d

[olljanat]

Closing this one now because we need figure out answer to #47 first.

[olljanat]

For everyone who is planning to run Kubernetes on top of BurmillaOS on longterm. Please check my new architecture proposal on #88