The current rendered site does not correctly link local in-repo
documents. This results in the LoadBalancer links on the Ingress User
Guide pages going to a 404.
Unfortunately this behavior is different between "normal" markdown
rendering in local IDEs and while viewing source files in GitHub. But
this change makes the rendered public site correctly link to the page.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
In addition to the extraPortMapping example, document how to run the
Ingress with a LoadBalancer provisioning by cloud-provider kind, that
provides a more realistic experience.
It also removes the specific implimentation details of the guide so it
is more agnostic of the Ingress implementation.
Change-Id: I865e72ca4571f0c513a1e9e412bc5e9c06a67a51
There were a couple problems in the Quick Start page under the Settings
for Docker Desktop section. There was a broken link to one of the macOS
Docker Desktop settings screenshots. There were also a couple missing
newlines that caused the formatting to be slightly off, running the text
in to the image rather than having a clean separation between them.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This adds a note to the Known Issues document with details related to
proper setup requirements for cgroupv2 support and links to the known
issues page for extra visibility from the Using WSL2 page.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This removes outdated information from the known issues page for
releases that are well past end of life. It also cleans up some
formatting and fixes a few markdown linting concerns.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
When running rootless podman, there can be issues with processes not
able to create new pids. This is caused by podman's default limit being
too low for scenarios like running nginx and spawning workers.
This simply adds a notice to the rootless section and suggests a way to
disable said limit if desired.
This restructures the installation instructions for kind to have the
first party, community supported methods listed first in the docs.
Third party maintained package installation instructions are moved to
the end of the list of installation options, and a note of warning is
added to point out that these packages are not maintained by the project
maintainers.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This makes minor updates and corrections to the docs under the Design
section for various updates to the project that have not made it into
the documentation.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This adds an entry to the known issues to call out the requirement for
kernel support for cgroup namespaces. This is a common gotcha for those
running older Linux distros. While this won't eliminate all bug reports
for those attempting to use kind in these environments, it will at least
add a clue to help explain when they encounter errors.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Updates the Contour ingress docs to link
to the Contour website for a usage example
since the kind example is nginx-specific.
Signed-off-by: Steve Kriss <krisss@vmware.com>
