Skip to content

Commit 0a7371e

Browse files
authored
Troubleshooting update and minor fixes (#37)
* - troubleshooting update - navigation fixes - small typo fixes * minor fixes
1 parent 30e3c0e commit 0a7371e

File tree

6 files changed

+12
-11
lines changed

6 files changed

+12
-11
lines changed

src/installation/install_epinio_auto.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Install Epinio (automatic dependencies)
22

3-
As described [in the top level document](src/installation/installation.md#installation-methods), this is the easiest method to get Epinio
4-
running. It's using [`Helm`](https://helm.sh/) with a chart to deploy all Epinio's dependencies on the target cluster automatically.
3+
As described [in the top level document](./installation.md#installation-methods) the easiest method to get Epinio
4+
running is using a [`Helm`](https://helm.sh/) chart to deploy all Epinio's dependencies on the target cluster automatically.
55

66
## Prerequisites
77

src/installation/install_epinio_manual.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install Epinio (the manual way)
22

3-
As described [in the top level document](src/installation/installation.md#installation-methods), this method is intended for production level setups where operators want to have full control of the process.
3+
As described [in the top level document](./installation.md#installation-methods) this method is intended for production level setups where operators want to have full control of the process.
44

55
## Prerequisites
66

@@ -17,7 +17,7 @@ may be configurable on the Epinio Helm chart.
1717
Linkerd ensures all communication between the various components is encrypted.
1818
Epinio runs fine with and without Linkerd.
1919

20-
Download the linkerd cli from here: https://github.com/linkerd/linkerd2/releases/
20+
Download the linkerd cli from here: [https://github.com/linkerd/linkerd2/releases/](https://github.com/linkerd/linkerd2/releases/)
2121
([stable-2.10.2 is known to work](https://github.com/epinio/installer/blob/e32f838c758e76c6c47559fa8d3c7f69a1c288cc/assets/installer/linkerd-job.yaml#L52))
2222

2323
Install linkerd with:

src/installation/install_epinio_on_k3d.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ epinio install --system-domain=<YOUR-IP>.omg.howdoi.website
4343
`<YOUR-IP>` can be found by running
4444

4545
```bash
46-
ifconfig |grep "inet.*broadcast
46+
ifconfig | grep "inet.*broadcast"
4747
```
4848

4949

src/installation/installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ There are at least 2 ways to install Epinio on a Kubernetes cluster. Which one
1414
you choose depends on the target environment and the amount of customization
1515
you want over the default Epinio installation.
1616

17-
1. [Install Epinio and automatically install dependencies](installation/install_epinio_auto.md) - Start here if you are new to Epinio
18-
2. [Install Epinio and manually install components](installation/install_epinio_manual.md) - Full control over installation, mostly for production setups
17+
1. [Install Epinio and automatically install dependencies](install_epinio_auto.md) - Start here if you are new to Epinio
18+
2. [Install Epinio and manually install components](install_epinio_manual.md) - Full control over installation, mostly for production setups
1919

2020
Epinio is not just one application running on your cluster. It depends on other Kubernetes components for some of its functionality. The 2 different installation methods above, provide different level of configurability on how you get those dependencies installed on your cluster. If you are just starting out with a fresh cluster and you don't have an opinion on how things should be installed, then the first method is the best for you.
2121

src/installation/system_requirements.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Also see [Provision of External IP for LoadBalancer service type in Kubernetes](
2828

2929
### Troubleshooting
3030

31-
While Kubernetes 1.22 is supported there is an issue when the container runtime is `containerd > 1.5.6`.
32-
The [pack cli](https://github.com/buildpacks/pack) is placing too much information into the
33-
image layers. The relevant issue is: https://github.com/paketo-buildpacks/full-builder/issues/415
31+
While Kubernetes 1.22 is supported there is an issue when the container runtime is `containerd > 1.5.6`: the [pack cli](https://github.com/buildpacks/pack) is placing too much information into the
32+
image layers ([relevant issue](https://github.com/paketo-buildpacks/full-builder/issues/415)).
33+
34+
This was fixed in version v1.5.8 of `containerd`, and the updated runtime is available from Kubernetes 1.22.4 onwward, so if you have a lower version please update.

src/tutorials/quickstart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ epinio push manifest.yaml
3535
Because of the default route the name has to be unique across all namespaces.
3636

3737
```bash
38-
epinio push --name sample --path samle-app
38+
epinio push --name sample --path sample-app
3939
```
4040

4141
***

0 commit comments

Comments
 (0)