Docs - SSL for Swarm using Traefik
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 67
- Forks
- 94
- Avg merge
- 5h 51m
- Merged PRs (30d)
- 1
Description
We have an SSL page for Kubernetes now but we should create one for Swarm - the simplest method I've used so far is Traefik which also provisions certificates using LetsEncrypt.
This is my example which I'm happy to donate to the documentation site: https://gist.github.com/alexellis/aad27285c099ed0878373569c0cdd567
I think it's also important to show how to enable basic auth for an embedded registry as part of this guide as that is a common ask and use-case for an OpenFaaS cluster. This is also included but we need to be careful re: the instructions for generating the Traefik basic auth password - since it is not straightforward and involves some manual steps (Google for this and you'll see it on StackOverflow) - the key thing is these instructions must be tested.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Kubernetes SSL page and the donated Traefik example at the linked gist. Validate the Swarm certificate provisioning and embedded-registry basic-auth instructions, especially password generation; done means a tested documentation guide covering both use cases.
Written by the indexing model from the issue text.
Assessment
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100