openfaas / openfaas/docs

Remove Certificate step from SSL page?

Open
#160 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted size/s
Dominant language
Makefile
Stars
67
Forks
94
Avg merge
5h 51m
Merged PRs (30d)
1

Description

Proposed change

We may be able to remove the additional create Certificate step from SSL page.. https://docs.openfaas.com/reference/ssl/kubernetes-with-cert-manager/

Context

It seems like cert-manager's Ingress shim (available since 0.2.2) automatically creates certificates if an Ingress object is decorated appropriately. This is simpler than us instructing the user to create a separate Certificate object.

Found by: @ajaegle

https://github.com/openfaas-incubator/ingress-operator/issues/6

Your Environment

We should test that the certificate is created automatically before removing the explicit step.

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 docs/reference/ssl/kubernetes-with-cert-manager/ and review the linked ingress-operator issue #6 alongside cert-manager's Ingress shim behavior. Verify that the certificate is created automatically with the documented setup; done means the explicit Certificate step can be removed without making the SSL instructions incomplete.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.