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 policy instructions to be compatible with non kind clusters #69

Merged
merged 2 commits into from
May 5, 2021
Merged

Conversation

mikeshng
Copy link
Member

@mikeshng mikeshng requested a review from dockerymick May 4, 2021 00:09
@mikeshng mikeshng changed the title update policy instructions to be compatible with non kind clusters - HOLD update policy instructions to be compatible with non kind clusters May 4, 2021
kind get kubeconfig --name <cluster name> --internal > $(PWD)/kubeconfig_hub
```

For non `kind` clusters:
Copy link
Member

Choose a reason for hiding this comment

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

I suggest to change non kind clusters to non-kind clusters

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks for catching that, done as suggested.

@@ -55,20 +55,36 @@ Complete the following steps to install the policy framework from prebuild image
governance-policy-propagator-8c77f7f5f-kthvh 1/1 Running 0 94s
```

4. Deploy the policy framework components to the managed cluster. Run the following commands:
4. Export the hub cluster kubeconfig with the following command:
Copy link
Member

Choose a reason for hiding this comment

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

I would monospace kubeconfig since it is in the command: kubeconfig

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks for catching that, done as suggested.

kubectl config use-context <hub cluster context> # kubectl config use-context kind-hub

kubectl apply -n default -f https://raw.githubusercontent.com/open-cluster-management/policy-collection/main/stable/CM-Configuration-Management/policy-pod.yaml
$ kubectl config use-context <hub cluster context> # kubectl config use-context kind-hub
Copy link
Member

Choose a reason for hiding this comment

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

Is the dollar sign required? I always thought that was like a cursor in the terminal

Copy link
Member Author

Choose a reason for hiding this comment

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

I always thought that was like a cursor in the terminal

I think the $ sign its just a Linux/Unix OS tradition to indicate its a terminal command. Since we are dealing with open source community, I think its more appropriate to use an open source OS convention. Thanks.

Is the dollar sign required?

In this case, I wanted the commands be distinguish from outputs that are results from the commands.

$ kubectl config use-context.... <--- command
$ kubectl apply -n default  .... <--- command as well
policy.policy.open-cluster-management.io/policy-pod created       <--- just outputs from the above command
placementbinding.policy.open-cluster-management.io/binding-policy-pod created    <--- just outputs from the above command
placementrule.apps.open-cluster-management.io/placement-policy-pod created  <--- just outputs from the above command

Copy link
Member

Choose a reason for hiding this comment

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

@mikeshng understandable, thanks for explaining!

Signed-off-by: Mike Ng <ming@redhat.com>
@mikeshng
Copy link
Member Author

mikeshng commented May 5, 2021

new commit to fix the items that doc team found. 8ee7841

Copy link
Member

@dockerymick dockerymick left a comment

Choose a reason for hiding this comment

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

Signed-off by: Mikela Jackson mdockery@redhat.com

@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dockerymick, mikeshng

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 9593ee0 into open-cluster-management-io:main May 5, 2021
@mikeshng mikeshng deleted the update-policy-non-kind branch May 5, 2021 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants