Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated install doc #986

Merged
merged 16 commits into from
Nov 14, 2024
Merged

Updated install doc #986

merged 16 commits into from
Nov 14, 2024

Conversation

maleck13
Copy link
Collaborator

@maleck13 maleck13 commented Nov 7, 2024

ignore the doc changes and port changes for now

Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.75%. Comparing base (cc1b41f) to head (154e72d).
Report is 34 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #986      +/-   ##
==========================================
+ Coverage   76.15%   83.75%   +7.60%     
==========================================
  Files         111       81      -30     
  Lines        8986     6619    -2367     
==========================================
- Hits         6843     5544    -1299     
+ Misses       1852      860     -992     
+ Partials      291      215      -76     
Flag Coverage Δ
bare-k8s-integration 15.91% <ø> (+5.03%) ⬆️
controllers-integration 76.19% <ø> (+17.33%) ⬆️
envoygateway-integration 41.02% <ø> (+8.51%) ⬆️
gatewayapi-integration 16.24% <ø> (+2.81%) ⬆️
istio-integration 43.61% <ø> (+9.28%) ⬆️
unit 17.09% <ø> (-8.27%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
api/v1beta1 (u) 90.00% <100.00%> (-2.19%) ⬇️
api/v1beta2 (u) ∅ <ø> (∅)
pkg/common (u) ∅ <ø> (∅)
pkg/istio (u) 62.06% <ø> (+15.03%) ⬆️
pkg/log (u) 93.18% <ø> (ø)
pkg/reconcilers (u) 24.67% <ø> (∅)
pkg/rlptools (u) ∅ <ø> (∅)
controllers (i) 86.71% <91.70%> (+2.28%) ⬆️

see 34 files with indirect coverage changes

@maleck13 maleck13 force-pushed the updated-install-doc branch 2 times, most recently from 9c73dd4 to 8495cae Compare November 11, 2024 14:37
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
@R-Lawton
Copy link
Contributor

im concisous we now have another way off installing for openshift and 4 ways of installing overall this is going to be a pain to maintain in time. I think it makes sense to have one way of installing openshift. what do you think about picking one way and documenting that. Makes sense to go with olm

@thomasmaas
Copy link
Contributor

Maybe discuss this in upcoming community call?

```

This will setup limitador to use provided redis connection URL as a backend store for ratelimit counters. Limitador will becomes temporarilly unavailable as it restarts.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention console plugin and how to enable it to

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe that should be a separate doc that this could link to? as it requires going into the UI etc right

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was mentioned in the other openshift doc but could be a separate doc to

Copy link
Contributor

@R-Lawton R-Lawton Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have a command for it now using the cli kubectl patch consoles.operator.openshift.io cluster --type='json' -p='[{"op": "add", "path": "/spec/plugins/-", "value": "kuadrant-console-plugin"}]'

@maleck13
Copy link
Collaborator Author

maleck13 commented Nov 12, 2024

This will replace the exising install guide @thomasmaas and @R-Lawton for OCP OLM will be the way to install for OCP installs. I want to get rid of what we have which uses cat <<EOF all over the place

maleck13 and others added 3 commits November 13, 2024 14:15
Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
Signed-off-by: David Martin <davmarti@redhat.com>
@maleck13 maleck13 force-pushed the updated-install-doc branch 2 times, most recently from 174d15b to a486f6d Compare November 13, 2024 15:03
@maleck13 maleck13 marked this pull request as ready for review November 13, 2024 15:38
Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED

Update observability resources to use gateway-system namespace (#969)

Signed-off-by: David Martin <davmarti@redhat.com>

add example for external api usage
Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
Copy link
Contributor

@R-Lawton R-Lawton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mainly make the doc follow the same style and tone as the majority of the other docs we have

config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
@R-Lawton
Copy link
Contributor

This will replace the exising install guide @thomasmaas and @R-Lawton for OCP OLM will be the way to install for OCP installs. I want to get rid of what we have which uses cat <<EOF all over the place

replace this one https://docs.kuadrant.io/0.11.0/kuadrant-operator/doc/install/install-openshift/ ?

@R-Lawton
Copy link
Contributor

Few things from running through this for the demo cluster:

Whats the user to do after this? is it the SPC walkthrough? if so also creates cluster issuers too as part of it. That doc is a whole other issue so many bugs in it but I'm in the process of creating a pr to fix it so i can remove the cluster issuer out of that in favour of yours.

What does "standard" mean for directory names this was a bit confusing

Would it make more sense to add the new install readme to the doc/instal/ directory so they are all together

maleck13 and others added 7 commits November 14, 2024 07:20
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
update multi cluster options

Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
@maleck13
Copy link
Collaborator Author

If we feel this doc is an improvement over the existing doc, we can merge as is and follow up with replacing the doc in the install directory entirely?
As for a follow on, we could suggest SCP but there doesn't really need to a follow on as installation is complete?

config/install/README.md Outdated Show resolved Hide resolved
Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
@R-Lawton
Copy link
Contributor

R-Lawton commented Nov 14, 2024

If we feel this doc is an improvement over the existing doc, we can merge as is and follow up with replacing the doc in the install directory entirely? As for a follow on, we could suggest SCP but there doesn't really need to a follow on as installation is complete?

yeah i think this doc can replace that one i think we could do it as part of this pr but don't mind it being done at a later time either we just cant forget about it. I think we should have a suggestion of what a user could do next after they have everything installed

Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
config/install/README.md Outdated Show resolved Hide resolved
Signed-off-by: craig <cbrookes@redhat.com>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
config/install/README.md Outdated Show resolved Hide resolved
Co-authored-by: Rachel Lawton <rlawton@redhat.com>
@R-Lawton
Copy link
Contributor

/lgtm
Nice work 🎉

@maleck13
Copy link
Collaborator Author

no code changes here so merging with out integration suite

@maleck13 maleck13 merged commit 526b0c9 into main Nov 14, 2024
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants