-
Notifications
You must be signed in to change notification settings - Fork 14
Address SME feedback across all documentation pages #134
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ Start the {TSFShortName} installer container using Podman. The installer runs in | |
| ---- | ||
| podman run -it --rm --env-file tsf.env \ | ||
| --entrypoint bash -p 8228:8228 --pull always \ | ||
| {TSFInstallerImage} --login | ||
| quay.io/redhat-ads/tsf-cli:unstable --login | ||
| ---- | ||
| + | ||
| This command pulls the latest installer image and opens an interactive shell session inside the container. The `--login` flag sources the shell profile, and port 8228 is exposed for the GitHub App creation workflow. | ||
|
|
@@ -93,6 +93,8 @@ products: | |
|
|
||
| NOTE: The {TSFShortName} installer assumes a fresh cluster. If other {TSFShortName}-managed operators are already installed (such as Red Hat OpenShift Pipelines or {RHTASName}), set `manageSubscription: false` for each pre-installed component to prevent conflicts. | ||
|
|
||
| The `tsf-config` ConfigMap in the `tsf` namespace controls which components are installed. Each component has an `enabled` flag and a `manageSubscription` property. Set `manageSubscription` to `false` for any component that is already installed on the cluster. | ||
|
|
||
| === Verification | ||
|
|
||
| Verify that the ConfigMap was created: | ||
|
|
@@ -104,6 +106,13 @@ oc get configmap tsf-config -n tsf | |
|
|
||
| The output shows the `tsf-config` ConfigMap in the `tsf` namespace. | ||
|
|
||
| To view the complete ConfigMap structure: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| oc get configmap tsf-config -n tsf -o yaml | ||
| ---- | ||
|
|
||
| == Configure the GitHub integration | ||
|
|
||
| Create and install a GitHub App that enables {TSFShortName} to interact with your GitHub repositories. The GitHub App provides webhooks for triggering builds and access to repository contents. | ||
|
|
@@ -175,11 +184,11 @@ If you are using GitLab instead of GitHub, configure the GitLab integration. Cre | |
| ---- | ||
| oc create secret generic gitlab-auth-secret \ | ||
| -n <tenant-namespace> \ | ||
| --from-literal=password=<project-access-token> \ | ||
| --from-literal=password="$GITLAB__TOKEN" \ | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All this section is going to much simplified by RHTAP-6483. |
||
| --type=kubernetes.io/basic-auth | ||
| ---- | ||
| + | ||
| Replace `<tenant-namespace>` with your tenant namespace and `<project-access-token>` with the token you copied. | ||
| The default tenant namespace is `default-tenant`. If multiple namespaces are used, the secret must be created in each namespace where you onboard components. For more information about tenant namespaces, see link:https://konflux-ci.dev/docs/advanced-how-tos/managing/environments/[Managing environments] in the {KonfluxName} documentation. | ||
|
|
||
| . Label the secret so that {KonfluxName} can discover it: | ||
| + | ||
|
|
@@ -196,10 +205,8 @@ oc label secret gitlab-auth-secret \ | |
| ---- | ||
| oc annotate secret gitlab-auth-secret \ | ||
| -n <tenant-namespace> \ | ||
| appstudio.redhat.com/scm.host=gitlab.com | ||
| appstudio.redhat.com/scm.host="$GITLAB__HOST" | ||
| ---- | ||
| + | ||
| Replace `gitlab.com` with the hostname of your GitLab instance if you are using a self-hosted instance. | ||
|
|
||
| === Verification | ||
|
|
||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove that bit.
Add
For GitLab the webhook is created and configured in the repository.under theAfter you create a component, {KonfluxName} automaticallysection.