-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OSDOCS-18105 [ROSA]: New Feature Log Forwarding in UI -WAIT to merge #113857
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
Open
jc-berger
wants to merge
1
commit into
openshift:main
Choose a base branch
from
jc-berger:jcberger-logforwarding-ui
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * observability/logging/rosa-forwarding-control-plane-logs.adoc | ||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="rosa-create-cluster-log-forwarding-ui_{context}"] | ||
| = Create a {product-title} cluster with log forwarding | ||
|
|
||
| [role="_abstract"] | ||
| You can set up control plane log forwarding when you create your {product-title} cluster in the {hybrid-console}. As you create your {product-title} cluster, you have the option to forward your control plane logs to an Amazon `S3` bucket, `CloudWatch` log group, or both. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In the {hybrid-console}, go to *Clusters* -> *Cluster List*, then click the *Create cluster* button. | ||
| . On the *Managed services* offerings page, go to the offering, *Red Hat OpenShift Service on AWS (ROSA)*, and click the *Create cluster* button, then select *With web interface*. | ||
| . For *Create a ROSA Cluster* -> *Control plane*, select your *ROSA hosted architecture*. | ||
| . For *Accounts and roles*, select your *Associated AWS infrastructure account* and *AWS billing account*. | ||
| . For the *Cluster settings* -> *Cluster details*, complete the following text boxes: | ||
| + | ||
| * *Region* | ||
| * *Cluster name* | ||
| * *Version* | ||
| * *Channel* | ||
|
|
||
| + | ||
| In about 20 minutes after you complete this information, your cluster is ready to install and you can continue to configure it. | ||
| . For *Machine pool* -> *Networking* -> *Configuration* -> *CIDR ranges* -> *Cluster roles and policies*, complete all of the required text boxes with the specifications that you want for your cluster. | ||
| . On the *Review and create* -> *Review your ROSA cluster* page, verify that the cluster details are correct. | ||
| . Optional: If you want to forward your control plane logs to an Amazon `S3` bucket or `CloudWatch` log group, complete the following instructions: | ||
| .. On the *Control plane log forwarding (optional)* page, click *Enable Amazon S3*, or *Enable CloudWatch*, or both. | ||
| .. If you enable Amazon `S3`, complete the following fields: | ||
| + | ||
| * *Bucket name*: Give it a unique identifier across all of {AWS}. | ||
| * *Bucket prefix*: Give it an optional path to organize your data. | ||
| * *Select groups and applications* (optional): When you select a group, the log forwarder collects all of the applications and related services from that group. | ||
| .. If you enable `CloudWatch`, complete the following fields: | ||
| + | ||
| * *Prerequisite*: Verify that you have created an `IAM` role and policy, then click the box stating that you have. | ||
| * *Log group name*: Give it a unique identifier. | ||
| * *Role ARN*: Give the `IAM` role ARN. For example, `arn:aws:iam::<12-digit-account-id>:role/<role-name>`. | ||
| * *Select groups and applications*: When you select a group, the log forwarder collects all the applications and related services from that group. | ||
| .. On the *Review and create* -> *Review your ROSA cluster* page, verify that the cluster details are correct. | ||
| .. Click the *Create cluster* button. | ||
| . If you want to finish completing your cluster with no designated log forwarding destination, click the *Create cluster* button. | ||
|
|
||
| .Verification | ||
|
|
||
| . In the {hybrid-console}, go to *Clusters* -> *Cluster List*. You can see the name and status of your cluster. | ||
| . Verify that the status of your cluster is “Ready” and click the name of your cluster. | ||
| . In the *Overview* tab, verify that the details of your cluster are what you specified. | ||
| . Go to the *Control plane log forwarding* section. | ||
| .. If you enabled `Amazon S3`, verify that you see *Amazon S3: Enabled*. If you did not set it up, it shows, *Amazon S3: Disabled*. | ||
| .. If you enabled `CloudWatch`, verify that you see *CloudWatch: Enabled*. If you did not set it up, it shows, *CloudWatch: Disabled*. | ||
| . Click *View details*, which takes you to the *Settings* tab. Confirm all the specific details for your control plane log forwarding are correct. | ||
|
|
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 |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * observability/logging/rosa-configuring-the-log-forwarder.adoc | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="rosa-create-cluster-ui-log-groups_{context}"] | ||
| = Creating a {product-title} cluster in the {hybrid-console} | ||
|
|
||
| [role="_abstract"] | ||
| You can forward logs from your {product-title} cluster to `CloudWatch`, `S3`, or both. When you forward your control plane logs, you can store them in the infrastructure that you designated, helping you meet compliance and audit requirements and workflows. | ||
|
|
||
| In the {hybrid-console}, you set up your {product-title} cluster to forward control plane logs when you create the cluster. Then, you can continue to use the web user interface (UI) to forward your control plane logs. | ||
|
|
||
| Enable control plane log forwarding when you create the cluster to ensure a complete audit trail. If enabled later, the feature cannot capture logs generated before the activation, leaving gaps in your data. |
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 |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * observability/logging/rosa-forwarding-control-plane-logs.adoc | ||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="rosa-edit-cluster-log-forwarding-ui_{context}"] | ||
| = Edit a {product-title} cluster with log forwarding | ||
|
|
||
| [role="_abstract"] | ||
| You can verify the status of log forwarding for a cluster and edit the log forwarding configurations. | ||
|
|
||
| .Procedure | ||
|
|
||
| . In the {hybrid-console}, go to *Clusters* -> *Cluster List*, then click the name of your cluster. | ||
| . Go to the *Settings* tab then the *Control plane log forwarding* section. | ||
| . To add to your log forwarding, click the *Add configuration* dropdown button. | ||
| .. You can add a `CloudWatch` or `Amazon S3` configuration. | ||
| . To make changes to your existing log forwarding, click the three dots within your `CloudWatch` or `Amazon S3` log forwarding configuration, then select *Edit configuration* or *Delete configuration*. | ||
| . When you click *Edit configuration* for `Amazon S3` log forwarding, you see your configuration and can make changes to the following: | ||
| * *Bucket Name* | ||
| * *Bucket Prefix* | ||
| * *Select groups and applications* | ||
| . When you click *Edit configuration* for `CloudWatch` log forwarding, you see your configuration and can make changes to the following: | ||
| * *Log group name* | ||
| * *Role ARN* | ||
| * *Select groups and applications* | ||
| . Make the changes to your configuration, then click *Save*. | ||
|
|
||
| .Verification | ||
|
|
||
| . In the *Settings* tab -> *Control plane log forwarding* section, verify that you see the changes you made to your configuration. The changes you made instantly go through and appear in this section. | ||
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
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.
this is fine, but i could've sworn we had like a three dot vertical image to be used in places like this. i might be misremembering though!