Red Hat Advanced Cluster Management for Kubernetes documentation
ISSUES OPENED HERE IN GITHUB ARE NOT MONITORED
If you are an external user opening a bug, please see Contributing to Red Hat Advanced Cluster Management for Kubernetes documentation.
If you are a developer and are interested in contributing or submitting a doc issue, please see the ACM Playbook for the correct procedure.
See the doc:
Links to the topics that contain the suggested updates:
Section:
Line 26 contains:
`Placement'
but it should be:
`Placement`
to correctly format the monospace font.
Doc team review of:
Please use editor to see if you can help me get the headers back so we can more easily see the sections:
Things I noticed:
Small typos, bold for emphasis (headers encouraged or no bold tag), conref in header may be causing issues (we were told to avoid characters).
I didn't fix the example @cadawson bc I am not sure what your outcome should be.
Something between 2.0, where headers were highlighted and commands were not, has changed with new entries to known issue. Also, a few new ones look like maybe troubleshooting.
Either way, I started a PR.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 or Sev 1 customer reported bugs for releases in support.
Links to the topics that contain the suggested updates:
See PR: #1061
prep step 1: empty code block
While the summary.md is a temporary solution, various links under GRC are not resolving (404)
Certificate policy controller
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/manage_policies/config_policy_ctrl.md
IAM policy controller
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/manage_policies/iam_policy_ctrl.md
CIS policy controller
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/manage_policies/cis_policy.md
Policy samples
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/manage_policies/policy_samples.md
-[] [ACM 4.4]
Note: For Common services and IBM Cloud Private version 3.2.1 and earlier defects, open up an issue in the roadmap repo.
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/summary.md
Links to the topics that contain the suggested updates:
The sizes required for the assisted installer storage areas are not in sync with what the service itself validates:
| Area | Documented | Validated |
|---|---|---|
| Database | - | 1G |
| Filesystem | 100G | 1G |
| Images | 50G | 10G |
The validations were introduced here:
We should sync both things, but not sure if we should decrease the requirements in the documentation or increase them in the validations.
While the summary.md is a temporary solution, the link to Supported environment is not resolving (404)
-[] [ACM 4.4]
Note: For Common services and IBM Cloud Private version 3.2.1 and earlier defects, open up an issue in the roadmap repo.
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/install/environments_overview.md
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/summary.md
Step 3 Edit the example ClusterRegistry cluster in the /test/resources/test_cluster.yaml file of the open-cluster-management repository
The link in the repository sends it to a location that does not exist
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/install/prep.md
Additionally:
I believe 3.11 is supported on RHEL 8
OCP 4 is not supported in RHEL 7
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 or Sev 1 customer reported bugs for releases in support.
Links to the topics that contain the suggested updates:
Section:
Create and use channels when you need to improve the continuous integration and delivery capabilities for creating and managing your Red Hat Advanced Cluster Management for Kubernetes applications.
Do Red Hat Advanced Cluster Management for Kubernetes applications have any continuous integration and delivery capabilities without the use of channels? This statement seems inaccurate.
Channels are custom resource definitions that can help you streamline deployments and separate cluster access.
Channel is a custom resource definition, but I think it's more accurate to say that channels are custom resources.Channels (channel.apps.open-cluster-management.io) define a namespace within the hub cluster and point to a physical place where resources are stored for deployment.
Channels are created on the hub cluster by pointing to the location where resources are stored. Channels are defined with a Channel custom resource definition (CRD). Channels reside in their own namespace for role-based access control.
I believe this should be CR again and not CRD. And it's not clear if all channels should be in 1 namespace or if each channel should reside in its own namespace. Testing it out myself, I confirmed that it is the latter, and that this is actually enforced. So I would suggest "Each channel resides in its own namespace for role-based access control."
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 or Sev 1 customer reported bugs for releases in support.
Links to the topics that contain the suggested updates:
Section:
Let's update the folder name troubleshoot_acm to troubleshooting, to match the book title. This will help with consistencies in the URL path. update links and xrefs link:../troubleshoot_acm/file_name.adoc to link:../troubleshooting/acm.adoc
I also would recommend that we update the troubleshooting.adoc filename to troubleshooting_intro.adoc
https://github.com/open-cluster-management/backlog/issues/3554
The YAML samples for creating a subscription that include a "timeWindow" should not be indented.
They should be the root element.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
apiVersion: apps.open-cluster-management.io/v1
kind: Subscription
metadata:
name: nginx
namespace: my-channel-subscription-nginx
labels:
app: nginx-app-details
spec:
channel: my-channel-namespace/my-development-channel
name: nginx-ingress
packageFilter:
version: "1.20.x"
placement:
placementRef:
kind: PlacementRule
name: my-placement-rule
**timeWindow:
type: "block"/"active"
location: "America/Los_Angeles"
daysofweek: ["Monday", "Wednesday", "Friday"]
hours:
- start: "10:20AM"
end: "10:30AM"
- start: "12:40PM"
end: "1:40PM"**
apiVersion: apps.open-cluster-management.io/v1
kind: Subscription
metadata:
name:
namespace:
labels:
spec:
sourceNamespace:
source:
channel:
name:
packageFilter:
version:
labelSelector:
matchLabels:
package:
component:
annotations:
packageOverrides:
- packageName:
packageAlias:
- path:
value:
placement:
local:
clusters:
name:
clusterSelector:
placementRef:
name:
kind: PlacementRule
overrides:
clusterName:
clusterOverrides:
path:
value:
**timeWindow:
type:
location:
daysofweek:
hours:
- start:
end:**
The documentation for creating a channel, there is a table that mentions "spec.pathname"
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/manage_applications/managing_channels.md
In the table with "spec.pathname", the Namespace type should be marked as required as well, in the UI you must provide a namespace when creating this type.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
Hi.
Is it possible to add as managed cluster the same cluster where the MultiClusterHub instance is?
Thank you.
Red Hatters please open issues in the developer backlog, or BugZilla if you are not an authorized user for the backlog.
Note: Doc team will update the current version and the two previous versions (n-2). For earlier versions, we will address only Sev 1, customer-reported bugs for releases in support.
Links to the topics that contain the suggested updates:
Section:
Missing --base-domain flag for the command hypershift create cluster aws command.
Also the value of AWS_CREDS is ambigous. Probably should be $HOME/.aws/credentials and not $HOME/name-aws
You must have a supported version of OpenShift Container Platform installed on premise.
I think on premise it's kind of misleading. You can have OCP installed on premise or any cloud provider. Both points (1) and (2) need to be well corrected.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
Reorganize your dashboard. You can personalize your view of the Overview dashboard by reorganizing the resource overview cards. You can view the following information about your clusters:
Currently we have in the Docs some troubleshooting about VxLAN for Submariner, but we should rather have a seperate section about all supported cable drivers.
For example, it should cover info about VxLAN as unencrypted connection - i.e. it is not advised to be used within pubic clouds, but only in an on-prem network.
Originally posted by @manosnoam in submariner-io/submariner-website#799 (comment)
In our Placement Rules documentation we currently reference the spec.clusterLabels parameter in the Placement rule definition YAML structure section as well as in both examples.
As per https://github.com/open-cluster-management/backlog/issues/924 spec.clusterLabels is not supported and the examples should be updated to use spec.clusterSelector instead. I have verified this within my own testing as well.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
I think it would be good to have further input from the app-lifecycle team with regards to the YAML structure section to verify if any other parameters need updating at this point.
I've updated the two examples to use spec.clusterSelector instead of spec.clusterLabel.
apiVersion: apps.open-cluster-management.io/v1
kind: PlacementRule
metadata:
name: gbapp-gbapp
namespace: development
resourceVersion: '9535041'
labels:
app: gbapp
chart: gbapp-0.1.0
heritage: Tiller
release: gbapp
selfLink: /apis/apps.open-cluster-management.io/v1/namespaces/development/placementrules/gbapp-gbapp
uid: d5b3cafa-c361-11e9-9fc2-0016ac101aef
spec:
clusterSelector:
matchExpressions:
- key: environment
operator: In
values:
- dev
clusterReplicas: 1
status:
decisions:
- clusterName: local-cluster
clusterNamespace: local-cluster
apiVersion: apps.open-cluster-management.io/v1
kind: PlacementRule
metadata:
name: towhichcluster
namespace: ns-sub-1
generation: 2
labels:
app: nginx-app-details
spec:
clusterReplicas: 1
clusterConditions:
- type: OK
clusterSelector:
matchExpressions:
- key: environment
operator: In
values:
- dev
While the summary.md is a temporary solution, the link to Configmap watcher service is not resolving (404)
-[] [ACM 4.4]
Note: For Common services and IBM Cloud Private version 3.2.1 and earlier defects, open up an issue in the roadmap repo.
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/cert_manager/refresh_cert.md
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/summary.md
404 - https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/cert_manager/refresh_cert.md
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
Links:
Section:
Modify the example or explicitly call out that the values needed for aws_access_key_id: and aws_secret_access_key: need to be base64 encoded
Currently in the documentation section Preparing Amazon Web Services to deploy Submariner it outlines the following example for the AWS secret key and secret key ID
cat << EOF | oc apply -f -
apiVersion: v1
kind: Secret
metadata:
name: <managed-cluster-name>-aws-creds
namespace: <managed-cluster-namespace>
type: Opaque
data:
aws_access_key_id: <aws-access-key-id>
aws_secret_access_key: <aws-secret-access-key>
EOF
This will fail when the setup begins as the values needed for aws_access_key_id: and aws_secret_access_key: need to be base64 encoded.
This is not stated anywhere in the documentation and no errors are thrown to indicate the configuration is incorrect.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
References to kubectl:
This is a hefty task (and maybe one more for individual squads to evaluate if it is done), but I think our docs should reflect that this is an Openshift deployment (and be consistent with the Openshift docs) by updating commands with kubectl that are intended for the RHACM hub cluster to use oc. (There are even locations right now where we say oc and then use kubectl, for example our Install docs)
The exception I can think of is when importing or otherwise dealing with Managed clusters, the commands should be kubectl.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 or Sev 1 customer reported bugs for releases in support.
Links to the topics that contain the suggested updates:
Section:
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
Content is now:
If you are using macOS, you must install gsed. If you do not already have gsed installed, you can install it by entering brew install gnu-sed in a terminal window.
Should be:
If you are using macOS, you must install gsed and watch. If you do not already have gsed and watch installed, you can install it by entering brew install gnu-sed watch in a terminal window.
At some point between 2.0 and 2.1 during the cross squad effort, we lost the headers in the editor view. While trying to see what was causing this, I noticed a few style issues, unnecessary formatting in header, and other minor errors, along with error formatting in an example.
For instance, we should not bold things for emphasis and if we maybe eliminate special characters in headers, they might return:
Former issue: https://github.com/open-cluster-management/backlog/issues/3316
https://github.com/open-cluster-management/rhacm-docs/blob/2.1_stage/release_notes/known_issues.adoc
I would like to look at VS Code together to fix and to examine format/style.
Hi.
I have deployed an instance of a MultiClusterHub, my default storageclass was not correct so there were some pods in pending state because the corresponding pvc was not bounded.
I remove the MultClusterHub instance to configure correctly the storageclasses and install the MultiClusterHub instance again.
After removing the instance the PVC mongodbdir-multicluster-mongodb-0 was not removed.
The instructions for preparing the hub cluster include kubectl commands. Consider changing those to oc commands, as the hub cluster must be OpenShift, and OCP admins will definitely have 'oc'. As far as I know, Red Hat does not provide a supported kubectl.
Links:
Section:
The above sections say "The WorkManager service route on the managed cluster", but for 2.3, there are no exact matches in the route object on the managed cluster as the WorkManager service route in the output below. Probably we want to make it similar to the actual route object name such as the klusterlet-addon-workmgr route object in the open-cluster-management-agent-addon namespace rather than WorkManager service route, so that we don't have to make a guess.
$ oc get -n open-cluster-management-agent-addon route
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
klusterlet-addon-workmgr klusterlet-addon-workmgr-open-cluster-management-agent-addon.apps.ocp4.49e4.sandbox191.opentlc.com klusterlet-addon-workmgr <all> passthrough None
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
While the summary.md is a temporary solution, the link to Refreshing cert-manager certificates is not resolving (404)
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/cert_manager/refresh_cert.md
-[x] [ACM 4.4]
Note: For Common services and IBM Cloud Private version 3.2.1 and earlier defects, open up an issue in the roadmap repo.
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/install/environments_overview.md
https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/summary.md
404 to https://github.com/open-cluster-management/rhacm-docs/blob/doc_stage/cert_manager/refresh_cert.md
Red Hatters please open issues in the developer backlog, or BugZilla if you are not an authorized user for the backlog.
Note: Doc team will update the current version and the two previous versions (n-2). For earlier versions, we will address only Sev 1, customer-reported bugs for releases in support.
Links to the topics that contain the suggested updates:
Section:
The word "your" appears twice in a row. "Read more to learn how to optimize your your managed..."
Links to the topics that contain the suggested updates:
Section:
The document says:
The key must be named, `thanos-ruler-custom-rules.yaml`, as shown in the following example.
But then the example shows:
----
data:
custom_rules.yaml: |
Now the question for me, as the reader, is: which is the correct key? thanos-ruler-custom-rules.yaml or custom_rules.yaml. My tests indicate that custom_rules.yaml is the correct key to use.
Links to the topics that contain the suggested updates:
Section:
The script in step one of that section produces invalid objects, and if followed, the configuration will fail. Specifically, it sets the following to the current date:
export POLICY_VERSION=$(date +"%m-%d-%y")
export TRUST_POLICY_VERSION=$(date +"%m-%d-%y")Those are then referenced as the values for the object's Version in later steps. The Version field is actually the date corresponding to when the schema was introduced, per: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_version.html
When I tested configuration following the documented steps, the objects failed to create on the AWS side because the current date is not a valid value. The correct value should be 2012-10-17 and when I hardcoded that value in the JSON, it worked.
Note: ID will update the current version and the two previous versions (n-2). For earlier versions, we will address only P1 & P2 Doc APARS for releases in support.
Hi,
How can I configure the storage class that the etc instance uses?
After installting the operator and creating a MultiClusterHub instance I see an etcd-cluster instance also, it by default uses the defautl storage class.
Is it possible to configure what storage class to use by the etcd instead of the default one?
Thank you.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.