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

Update the Known issue the topic renaming[Global Hub 1.3.0] #1053

Merged
merged 2 commits into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,34 @@ For common Troubleshooting issues, see [Troubleshooting](troubleshooting.md).

## Known issues

1. A managed cluster that is not created successfully (clusterclaim `id.k8s.io` does not exist in the managed cluster) is not counted in global hub policy compliance dashboards, but shows in the Red Hat Advanced Cluster Management policy console.
2. If the Globalhub Operator installed in OCP 4.13, all hyperlink which link to RHACM ManagedClusters list/detail pages in dashboards may redirect to the RHACM home page. It is caused by [issue](https://issues.redhat.com/browse/OCPBUGS-19048)
3. In `Global Hub - Policy Group Compliancy Overview` dashboards, we can check one data point by click the link of `View Offending Policies` for standard group: xxx, but after we click this link to go to the offending page, the standard group filter can not pass to the new page. The `Global Hub - Cluster Group Compliancy Overview` has the same issue.
### Managed cluster does not exist in the dashboard

If you do not successfully create a managed cluster, you cannot find it in the global hub policy compliance dashboards, but you can see it in the Red Hat Advanced Cluster Management policy console. When you create your managed cluster, note that the clusterclaim, `id.k8s.io`, does not exist in the managed cluster.

### Links redirect to RHACM home page

If you install the global hub operator in OCP 4.13, the links to the RHACM managed clusters dashboard pages might redirect you to the RHACM dashboard home page page instead. For more details on this issue, see the [open issue](https://issues.redhat.com/browse/OCPBUGS-19048)

### Standard group filer does not work

In `Global Hub - Policy Group Compliancy Overview` dashboards, check your data point by clicking **View Offending Policies** for `standard group: xxx`. When you get to the offending page, the standard group filter does not continue to the new page. This same issue exists for the `Global Hub - Cluster Group Compliancy Overview` dashboard.

### Upgrading from Global Hub 1.2 to 1.3 (only for BYO Kafka)

Copy link
Contributor

@hchenxa hchenxa Aug 16, 2024

Choose a reason for hiding this comment

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

let's try to use spec and status topics as an example. the event topics` can be deprecated.

Copy link
Contributor

Choose a reason for hiding this comment

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

Some minor changes to align more with Red Hat style guides:

There are three topics named spec, status and event in your Kafka cluster. You can configure these Kafka topics after you upgrade Kafka to global hub 1.3 or later. After this upgrade, you only have two topics in the system: one for spec path and one for status path. The default external topic is gh-spec and gh-status. Align these topics between your Kafka clusters and the Global Hub operand. You can either create these two topics in your Kafka cluster, or you can modify the operand to use the existing topics in your Kafka cluster. For example, you can update the operand by using the existing spec and event topics.

There are 3 topics named `spec`, `status` and `event` in your kafka cluster. However the kafka topics can be configured after upgrading it to 1.3. Notably, we will only keep 2 topics in the for the system: one for spec path and the other for status path. The default external topic will be `gh-spec` and `gh-status`. So ensure these are aligned between your Kafka clusters and the Global Hub operand. You can either create these two topics in your Kafka cluster or modify the operand to use the existing topics in your Kafka cluster. For example, updating the operand using existing `spec` and `event` topics.

Copy link
Contributor

Choose a reason for hiding this comment

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

Use the following yaml sample to update your operand:

< the yaml you have here >

```yaml
apiVersion: operator.open-cluster-management.io/v1alpha4
kind: MulticlusterGlobalHub
...
spec:
availabilityConfig: Basic
dataLayer:
kafka:
topics:
specTopic: spec
Copy link
Contributor

@hchenxa hchenxa Aug 16, 2024

Choose a reason for hiding this comment

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

should be status may be? since your spec name is statusTopics.

Copy link
Member Author

Choose a reason for hiding this comment

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

The default topics are gh-spec and gh-event. @clyang82 What's your idea about it?

statusTopic: event
postgres:
retention: 18m
enableMetrics: false
```
10 changes: 7 additions & 3 deletions doc/byo.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@ kubectl create secret generic multicluster-global-hub-transport -n multicluster-
--from-file=client.crt=<Client-cert-for-kafka-server> \
--from-file=client.key=<Client-key-for-kafka-server>
```
Please note that:
- Three topics `spec` `status` and `event` are needed. If your Kafka is configured to allow creating topics automatically, you can skip this step. Otherwise, you need to create the topics manually. And ensure that the above Kafka user has the permission to read data from the topics and write data to the topics.
- Kafka 3.3 or later is tested.

*Prerequisite:* See the following requirements for bringing your own Kafka:

- Unless you configured your Kafka to automatically create topics, you must manually create two topics for spec and status(The default topics are `gh-spec` and `gh-status`). When you create these topics, ensure that the Kafka user can to read and write data to the these topics. And also make sure the topic names in the Global Hub operand is aligned with the topics you created.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Unless you configured your Kafka to automatically create topics, you must manually create two topics for spec and status. The default topics are gh-spec and gh-status. When you create these topics, ensure that the Kafka user can read and write data to the these topics. Ensure that the topic names in the Global Hub operand is aligned with the topics you created.


- Kafka 3.3 or later is tested.\

- Suggest to have persistent volume for your Kafka.

## Bring your own Postgres
Expand Down
Loading