Kuadrant / Kuadrant/docs.kuadrant.io

Prerequisites for installation on OpenShift lacking details

Open
#133 4 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Python
Stars
24
Forks
25
PR merge metrics
No merged PRs in 30d

Description

The [installation guide](https://docs.kuadrant.io/0.8.0/kuadrant-operator/doc/install/install-openshift/) mentions the following in the prerequisites:

>AWS account with Route 53 and zone.

There is in fact a lot of work to be done to satisfy this requirement that I think could be facilitated by some additional details on why Kuadrant needs this, what is the purpose of the various records and the roles & responsibilities of the components within Kuadrant regarding this external service and its configuration.

I have documented the steps required to perform a successful integration with Route 53 [here](https://api-mgmt.pages.redhat.com/team-docs/knowledge_sharing_sessions/knowledge_session19/#prerequisites). I wouldn't expect such detailed steps to be documented for Kuadrant but maybe we can link to the [AWS documentation](https://repost.aws/knowledge-center/create-subdomain-route-53) that I had to follow to be able to do this and explain the relationship between the various configuration and records to be created with the different Kuadrant components responsible for managing this?

As I attempted to do in the guide I wrote I think it's important for the user to understand the roles of the following resources:

- `ManagedZone`
- `HTTPRoute`
- `DNSPolicy`

Because to someone unfamiliar with Kuadrant it is not obvious and knowing this can also help the user self-resolve any issues that occur during the process rather than figuring it out themselves and ultimately opening a ticket before they have even completed the prerequisites successfully.

Let me know what you think and whether any of the guide I have written makes sense in the upstream documentation and I would be happy to submit a PR.

Contributor guide

Open the contributing guide

Research direction

Start with the OpenShift installation guide linked in the issue and compare it with the author's Route 53 integration guide and the AWS documentation link. Explain why Route 53 is needed, how ManagedZone, HTTPRoute, and DNSPolicy relate to it, and link to useful setup guidance; done means the prerequisite is understandable without requiring a support ticket.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, 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.