pulp / pulp/pulp-operator

[DOC] Add steps to configure Ingress resource

Open
#677 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation go-alpha
Dominant language
Go
Stars
88
Forks
66
Avg merge
53m
Merged PRs (30d)
1

Description

We could add a section in the documentation with the instructions to configure the operator to deploy the Ingress resources.
For example:

  • what are the pre-requisites
  • how to configure Pulp CR to enable external access to Pulp using Ingress (show which fields in Pulp CR should be modified)
    • we can describe with an example how to configure Pulp to use ingress

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 by locating the documentation for configuring the Pulp CR and the ingress_host setting. Cover DNS prerequisites using external-dns, an available ingress controller and preferably an IngressClass, then document the relevant fields with a working example; done when users can follow the section to enable external access through Ingress.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.