Skip to content

Commit

Permalink
Troubleshooting update and minor fixes (#37)
Browse files Browse the repository at this point in the history
* - troubleshooting update
- navigation fixes
- small typo fixes

* minor fixes
  • Loading branch information
enrichman authored Jan 14, 2022
1 parent 30e3c0e commit 0a7371e
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 11 deletions.
4 changes: 2 additions & 2 deletions src/installation/install_epinio_auto.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Install Epinio (automatic dependencies)

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

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions src/installation/install_epinio_manual.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Install Epinio (the manual way)

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.
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.

## Prerequisites

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

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

Install linkerd with:
Expand Down
2 changes: 1 addition & 1 deletion src/installation/install_epinio_on_k3d.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ epinio install --system-domain=<YOUR-IP>.omg.howdoi.website
`<YOUR-IP>` can be found by running

```bash
ifconfig |grep "inet.*broadcast
ifconfig | grep "inet.*broadcast"
```


Expand Down
4 changes: 2 additions & 2 deletions src/installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ There are at least 2 ways to install Epinio on a Kubernetes cluster. Which one
you choose depends on the target environment and the amount of customization
you want over the default Epinio installation.

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

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.

Expand Down
7 changes: 4 additions & 3 deletions src/installation/system_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Also see [Provision of External IP for LoadBalancer service type in Kubernetes](

### Troubleshooting

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
image layers. The relevant issue is: https://github.com/paketo-buildpacks/full-builder/issues/415
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
image layers ([relevant issue](https://github.com/paketo-buildpacks/full-builder/issues/415)).

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.
2 changes: 1 addition & 1 deletion src/tutorials/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ epinio push manifest.yaml
Because of the default route the name has to be unique across all namespaces.

```bash
epinio push --name sample --path samle-app
epinio push --name sample --path sample-app
```

***
Expand Down

0 comments on commit 0a7371e

Please sign in to comment.