docs(kgo): add Konnect entities documentation #8084
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
czeslavo
added
the
review:general
czeslavo
force-pushed
the
kgo/konnect-entities-guide
branch
from
2a09335 to
c1077b7
Compare
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
czeslavo
changed the title
czeslavo
force-pushed
the
kgo/konnect-entities-guide
branch
3 times, most recently
from
48c69fe to
1f00a26
Compare
2 tasks
pmalek
reviewed
Oct 25, 2024
app/_src/gateway-operator/guides/konnect-entities/service-and-route.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/service-and-route.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/service-and-route.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/tagging-and-labeling.md
Outdated
Show resolved
Hide resolved
Comment on lines
84
to
93
| The output should look similar to this: | ||
|
|
||
| ```console | ||
| { | ||
| "observedGeneration": 1, | ||
| "reason": "Programmed", | ||
| "status": "True", | ||
| "type": "Programmed" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
I'm wondering if this wouldn't make sense to put this into an importable/includable snippet to deduplicate some code
app/_src/gateway-operator/guides/konnect-entities/key-and-keyset.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/key-and-keyset.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/key-and-keyset.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/upstream-and-target.md
Outdated
Show resolved
Hide resolved
app/_src/gateway-operator/guides/konnect-entities/upstream-and-target.md
Outdated
Show resolved
Hide resolved
1 task
pmalek
force-pushed
the
kgo/konnect-entities-guide
branch
from
d60dfd3 to
58b2461
Compare
pmalek
reviewed
Oct 28, 2024
czeslavo
force-pushed
the
kgo/konnect-entities-guide
branch
from
58b2461 to
2c459b5
Compare
czeslavo
force-pushed
the
kgo/konnect-entities-guide
branch
2 times, most recently
from
abcf11a to
df9e6a9
Compare
czeslavo
force-pushed
the
kgo/konnect-entities-guide
branch
from
df9e6a9 to
bca5c37
Compare
pmalek
reviewed
Oct 29, 2024
| You can verify the `KongService` was reconciled successfully by checking its `Programmed` condition. | ||
|
|
||
| ```shell | ||
| kubectl get kongservice service -o=jsonpath='{.status.conditions}' | jq '.[] | select(.type == "Programmed")' |
There was a problem hiding this comment.
kubectl natively supports filtering:
... -o=jsonpath="{.status.conditions[?(@.type==\"Programmed\")]}"
If we want to pretty print this then we can just pipe it to jq at the very end.
Guaris
requested changes
Oct 29, 2024
app/_src/gateway-operator/guides/konnect-entities/certificate-and-cacertificate.md
Outdated
Show resolved
Hide resolved
| to create a `KonnectAPIAuthConfiguration` object that will be used by the {{site.kgo_product_name}} to authenticate | ||
| with Konnect APIs. | ||
|
|
||
| ### Create a Konnect API Auth Configuration |
There was a problem hiding this comment.
Suggested change
| ### Create a Konnect API Auth Configuration | |
| ### Create a {{site.konnect_product_name}} API Auth Configuration |
There was a problem hiding this comment.
I'm not sure about lower casing this. I referred to Writing for Kong guide and it says:
Use title case for titles of pieces and calls to action. Use sentence case for all other headers.
This header is a call to action, so I'd keep it capitalized, WDYT?
There was a problem hiding this comment.
Ah, the marketing style guide is different than the docs style guide. We specifically use sentence case for all headers.
app/_src/gateway-operator/guides/konnect-entities/upstream-and-target.md
Outdated
Show resolved
Hide resolved
pmalek
force-pushed
the
kgo/konnect-entities-guide
branch
from
d351492 to
0058b19
Compare
|
Rebased on |
Co-authored-by: Patryk Małek <[email protected]>
Co-authored-by: Angel <[email protected]>
czeslavo
force-pushed
the
kgo/konnect-entities-guide
branch
from
1246263 to
3f077c5
Compare
Co-authored-by: Angel <[email protected]>
Guaris
approved these changes
Oct 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a Konnect entities prerequisites building block (describing the KGO installation and
KonnectAuthConfigurationcreation steps) along with a first guide describingKonnectGatewayControlPlaneusage. It also adds guides for:It's based on #8083 which prepares v1.4.x release nav etc.
Part of Kong/gateway-operator#439.
Testing instructions
Preview links:
Checklist