Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add containerd warning to getting-started.md #828

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+29 −1
Open

Add containerd warning to getting-started.md #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea92cad
add warning to getting-started.md
eaudetcobello Nov 21, 2024
d8ffe48
add troubleshoot
eaudetcobello Nov 21, 2024
745ce48
change warning to prerequisite
eaudetcobello Nov 23, 2024
43f9403
add link
eaudetcobello Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/src/snap/reference/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,31 @@ EOF
reboot
```

## The path required for the containerd socket already exists

### Problem

{{product}} tries to create the containerd socket to manage containers,
but it fails because the socket file already exists, which indicates another
installation of containerd on the system.

### Explanation

In classic confinment mode, {{product}} uses the default containerd
paths. This means that a {{product}} installation will conflict with
any existing system configuration where containerd is already installed.
For example, if you have Docker installed, or another Kubernetes distribution
that uses containerd.

### Solution

We recommend running {{product}} in an isolated environment, for this purpose,
you can create a LXD container for your installation. See
[Install {{product}} in LXD][lxd-install] for instructions.
nhennigan marked this conversation as resolved.
Show resolved Hide resolved

<!-- LINKS -->

[lxd-install]: ../howto/install/lxd.md
[kubeconfig file]: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/
[kubernetes-122955]: https://github.com/kubernetes/kubernetes/issues/122955
[kubernetes-125923]: https://github.com/kubernetes/kubernetes/pull/125923
Expand Down
7 changes: 6 additions & 1 deletion docs/src/snap/tutorial/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ explains how to install the snap package and some typical operations.
[snapd documentation](https://snapcraft.io/docs/installing-snapd))
- System Requirements: Your machine should have at least 40G disk space
and 4G of memory
- A system without any previous installations of containerd/docker. Installing
either with {{product}} will cause conflicts. If a containerization solution is
required on your system, consider [using LXD][LXD] to isolate your
installation.

### 1. Install {{product}}

Expand Down Expand Up @@ -220,4 +224,5 @@ This option ensures complete removal of the snap and its associated data.
[Adding and Removing Nodes]: add-remove-nodes
[Storage]: ../howto/storage/index
[Networking]: ../howto/networking/index.md
[Ingress]: ../howto/networking/default-ingress.md
[Ingress]: ../howto/networking/default-ingress.md
[LXD]: ../howto/install/lxd.md
Loading