Kuadrant / docs.kuadrant.io

https://docs.kuadrant.io
8 stars 14 forks source link

Prerequisites for installation on OpenShift lacking details #133

Open kevprice83 opened 2 months ago

kevprice83 commented 2 months ago

The installation guide 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. I wouldn't expect such detailed steps to be documented for Kuadrant but maybe we can link to the AWS documentation 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:

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.

jayachristina commented 2 months ago

there is some content documented here that could help with the prerequisites

https://developers.redhat.com/articles/2024/06/12/getting-started-red-hat-connectivity-link-openshift#install_connectivity_link

smccarthy-ie commented 2 months ago

@kevprice83 This is great feedback, thanks. Yes, I think we might need to add links to cloud DNS provider docs.

Note that the requirement to create a ManagedZone will no longer apply in v0.9. See https://github.com/Kuadrant/kuadrant-operator/pull/793