linkerd / linkerd/website

end-to-end ingress instructions

Open
#318 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
60
Forks
221
Avg merge
4h 32m
Merged PRs (30d)
1

Description

## Background
https://linkerd.io/2/tasks/exposing-dashboard/ describes exposing `linkerd dashboard` via an ingress resource. Configuration of the ingress-controller (nginx or traefik) is left up to the user.

## Proposal

Update the docs to include an end-to-end working example of exposing `linkerd dashboard` via ingress, including ingress controller configs, service resources, and support for websockets.

These configs could even live in the https://github.com/linkerd/linkerd-examples repo, allowing the instructions to simply be:

```bash
linkerd install | kubectl apply -f -
curl https://raw.githubusercontent.com/linkerd/linkerd-examples/master/ingress/nginx.yml
open localhost.linkerd # or similar, prefer not requiring /etc/hosts modification
```

## Related issues

- linkerd/website#211
- linkerd/linkerd2#2143

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing exposing-dashboard task at linkerd.io/2/tasks/exposing-dashboard/ and review the related issues linkerd/website#211 and linkerd/linkerd2#2143. Determine whether the example belongs in the website or linkerd-examples, then provide a reproducible ingress-controller setup with service resources and websocket support; done means the dashboard works through ingress without manual controller configuration or an /etc/hosts edit.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, nginx
Domain
devops, documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.