containers / podman-desktop

Podman Desktop is the best free and open source tool to work with Containers and Kubernetes for developers. Get an intuitive and user-friendly interface to effortlessly build, manage, and deploy containers and Kubernetes — all from your desktop.
https://podman-desktop.io
Apache License 2.0
4.61k stars 293 forks source link

docs: new _Onboarding_ section #3888

Closed themr0c closed 1 year ago

themr0c commented 1 year ago

Onboarding introduction.

Started as a single diagram, evolved into a compleye onboarding introduction.

deboer-tim commented 1 year ago

The horizontal and downward arrows make this look a little too much like a flow to me, i.e. I install Podman, the OpenShift Local, then Lima, next I do Podman and Docker, etc. As a user it's also not clear why something like OpenShift Local is in VM and Kubernetes columns and if this means I need to set it up twice or what.

I guess the bottom line is that it's not clear to me what we're showing here, and if it is just meant as a catalog to find things in a particular category, a one-stop shop for all starting points, or something else. As a user, how does this help vs the existing nav or googling what I'm trying to install?

Could we also pick colors from the palette / existing colors from the website so that things match?

themr0c commented 1 year ago

OK, make clear that at every column you have the choice between each item in the column

themr0c commented 1 year ago

That's already with the colors from the palette as much as we can.

themr0c commented 1 year ago

mairin commented 1 year ago

@deboer-tim It is using color values from our palette file, although I think it transforms the colors based on whether or not you're in light or dark mode. I think the dark mode version is more on-brand. I haven't quite fully figured out the theming system yet.

afbjorklund commented 1 year ago

The diagram is missing the option to only install Kubernetes, directly on the virtual machine provided by Lima.

That is, it is not using the container engine (Podman, Docker) but only the container runtime (CRI-O, containerd)


It could even be listed twice as "Lima: k3s" and "Lima: k8s", depending on which installer the user chooses:

https://podman-desktop.io/docs/Installation/creating-a-lima-instance-with-podman-desktop#kubernetes

themr0c commented 1 year ago

@afbjorklund This diagram would make more sense then?

themr0c commented 1 year ago

Even more complete:

https://mermaid.live/edit#pako:eNp1U8GOmzAQ_RXLZ7MKIZu03KruodImbbWRKrXyxcGTYAFjZEybNMq_19gkwKY5Me_NG8_4mTnTTEugKY2iiGOmca8OKUdCGoEFnHzoQK7__BBlC01K9qJsINDoSj-V6oAVoE2JUYfccvQnhfJoB1Zw5LjWmSjZdy0rgaQSWa4QWHzlvwqrfgNZK2yPjNzotarEIHoDSb4IS77VgNtc7S0J_E3worMCDJHQFFbXHc_xXccAxym2tQKlKDUCcbe3wslM0yn6vPuM4Wdd1bqBEfOqUI7gRqEq2h2EJpObDd0ndJg76P2VB52HQ97D18TNQ67AdTIIFppQ_8ikjcqM9kSne6S64f-Lts6pnT5OZRzf-T6M20cPHe7zI0t75mppD6eWvkGlLbDH48U3zU_dGtJVkvBjhwPu2Ml97rJT6-7S0xe4T3evRRmtwFRCSbdo5253OLU5VMBp6kIpTMEpx4vTidbq7QkzmlrTAqNtLYWFFyUORlQ09cvHKEhltdmEzfULzGgtkKZneqRpFC-fFsmHZDmbx4t5kiwYPdF0NZ89rZar1WwWf3xO4vnzhdG_WrtDY1_8y8dd18s_CjpqvQ

afbjorklund commented 1 year ago

I was more thinking to add two boxes in the Kubernetes column, but it's OK to scope them out...

They're covered by the "bring your own kubeconfig" (until they can be provided), for the provider.

lima-type

Just that your diagram seemed to imply that podman/docker is required for running Kubernetes

themr0c commented 1 year ago

With all the feedback received, it's going in a new direction.

New outline:

Sankey diagram does not bring clarity. New attempt with timeline diagram and matrix tables.

themr0c commented 1 year ago

Onboarding for container workloads

To run container workloads, set up at least one container engine.

Podman Desktop does not automatically set up container engine resources that you might not need.

Procedure

  1. Select a container engine supporting your workload.

    Workload Podman Docker
    Rootless containers yes no
    Rootful containers yes yes
    Compose yes yes
    Pods yes no

    Podman supports rootless container and pods, in addition to rootful containers and Compose.

  2. Select an execution environment supporting your container engine and your operating system.

    • Select a Podman execution environment:

      Host operating system Native containers Podman machine Lima machine
      Windows no yes no
      macOS no yes yes
      Linux yes no no
    • Select a Docker execution environment:

      Host operating system Native containers Lima machine Docker Desktop
      Windows no no yes
      macOS no yes yes
      Linux yes no yes
  3. Setup your container engine.

    Podman Desktop assists you to set up Podman and Podman machines on Windows and macOS, and consumes your native Podman, Lima or Docker setup.

themr0c commented 1 year ago

(Added the content as a comment for better visualization)

afbjorklund commented 1 year ago

Lima works also on Linux, and will eventually also support Windows (there is an experimental WSL2 driver already)

afbjorklund commented 1 year ago

Podman machine also supports Linux (accelerated by KVM), it is just disabled (not available) in Podman Desktop.

themr0c commented 1 year ago

@afbjorklund @jeffmaury Suggestions implemented. Do they work for you?

afbjorklund commented 1 year ago

Thanks for updating, not easy doing these comparisons for constantly updated and "highly political" targets

themr0c commented 1 year ago

True :). How many iterations on this pull request, and still learning some details :). Can I count on you to create an issue here to update our docs once Windows support gets stable in Lima?

afbjorklund commented 1 year ago

Sure, I can update the Lima content... And I think Podman will get similar updates, once it supports VMs (Hyper-V) in addition to WSL

afbjorklund commented 1 year ago

I am also looking for feedback from Lima users on Mac, if they prefer the CLI or the GUI* for setting it up? (creating and starting, that is)

* https://github.com/afbjorklund/lima-gui