openfaas/docs

Remove Certificate step from SSL page?

Open

#160 opened on Jul 1, 2019

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)Makefile (95 forks)auto 404
good first issuehelp wantedsize/s

Repository metrics

Stars
 (67 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Test if cert manager's Ingress shim automatically creates Certificate objects when Ingress is annotated; if so, remove the explicit step from the SSL page.
Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90