Skip to content

Add Uninstall feature, add Makefile commands and organize docs #898

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

Closed
wants to merge 4 commits into from
Closed

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Jun 9, 2019

Motivation

#896
#789

What

  • Add command make uninstall
  • Add make commands for manual/local installation
  • Organize information into the README. MD and doc/install.md
  • Add github files (PR/Issue templates)
  • Add CONTRIBUTION.MD doc
  • Replace the directory "Documentations" for doc in order to follow the project and org standards

Why

  • Adding missing steps to install
  • Make the info more easy to understand and to find
  • Follow the org standards
  • Asked for the required info when someone opens an issue
  • Give a better user experience

Steps to verify

@openshift-ci-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: camilamacedo86
To complete the pull request process, please assign njhale
You can assign the PR to them by writing /assign @njhale in a comment when ready.

The full list of commands accepted by this bot can be found 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-ci-robot openshift-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jun 9, 2019
@openshift-ci-robot
Copy link
Collaborator

Hi @camilamacedo86. Thanks for your PR.

I'm waiting for a operator-framework or openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot openshift-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 9, 2019
@camilamacedo86
Copy link
Contributor Author

camilamacedo86 commented Jun 10, 2019

c/c @njhale @alecmerdler @ecordell @jpeeler @fabiand @mhrivnak @wallyqs @mhrivnak @estroz @lilic @tkashem could you give me a hand here with the review/approval?

@fabiand
Copy link
Contributor

fabiand commented Jun 14, 2019

This PR looks pretty good to me (a lot of eye on the details!), but I'm not an OLM maintainer.

@camilamacedo86 camilamacedo86 changed the title Add Makefile commands and organize docs Add Uninstall feature, add Makefile commands and organize docs Jun 17, 2019
Copy link
Member

@ecordell ecordell left a comment

Choose a reason for hiding this comment

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

Thanks for the help! I think there are a couple of issues specifically around how we support OCP <4, but otherwise this is great!

- kubectl apply -f deploy/upstream/quickstart/crds.yaml
- kubectl apply -f deploy/upstream/quickstart/olm.yaml

.PHONY: install-ocp
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure we should have this - OLM is already in OCP

Copy link
Contributor Author

@camilamacedo86 camilamacedo86 Jun 17, 2019

Choose a reason for hiding this comment

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

In OCP 4 was released, however, how to test it locally? For Minishift it still required. I removed the 3.11 for the doc and a few changes in order to make it more clear. Please, let me know what do you think and if we can move forward in this way.

install-ocp:
@echo Applying upstream quick start crd
- kubectl create -f deploy/ocp/manifests/latest/
- oc adm policy add-cluster-role-to-user cluster-admin system:serviceaccount:kube-system:default
Copy link
Member

Choose a reason for hiding this comment

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

Why is this clusterrolebinding needed?

Copy link
Contributor Author

@camilamacedo86 camilamacedo86 Jun 17, 2019

Choose a reason for hiding this comment

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

To allow use it with Minishift.

README.md Outdated
spec:
channel: alpha
name: etcd
source: rh-operators
Copy link
Member

Choose a reason for hiding this comment

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

We should change these to point to the operatorhubio catalogs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did a few changes. Please, check if it is ok for you now.


**NOTE** It is recommended for development pruposed and will use the source locally

## Minishift
Copy link
Member

Choose a reason for hiding this comment

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

Minishift is deprecated, we don't want to steer users towards it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Deprecated for OLM? Where it was deprecated? How to test it locally with OCP?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added the info that it is deprecated. I think we should keep it for a while

@ecordell
Copy link
Member

/ok-to-test

@openshift-ci-robot openshift-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jun 19, 2019
@camilamacedo86
Copy link
Contributor Author

Hi @ecordell, could you please re-check it? Could we move forward here?

@camilamacedo86
Copy link
Contributor Author

Hi @ecordell,

All your comments were addressed. Please, could you check and let me know what still needs to be changed for we move forward here.

@camilamacedo86
Copy link
Contributor Author

camilamacedo86 commented Jul 19, 2019

Hi folks @njhale, @ecordell, @alecmerdler @jpeeler
Please, could we move forward here now or could you let me know what is missing?

@openshift-ci-robot openshift-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 21, 2019
@openshift-ci-robot openshift-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 4, 2019
@camilamacedo86
Copy link
Contributor Author

Hi folks @joelanford and @ecordell,

if you have time, could you please give me a hand for we are able to move forward here?
If you think that we should no move forward with nothing that was done here it is fine as well. Please, just let me know for we are able to close the PR in this situation.

@openshift-ci-robot openshift-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 17, 2019
@camilamacedo86
Copy link
Contributor Author

Closing it. It is open for a while and shows outdated currently.

@openshift-ci-robot
Copy link
Collaborator

@camilamacedo86: The following tests failed, say /retest to rerun them all:

Test name Commit Details Rerun command
ci/prow/e2e-aws-console-olm f7214b2 link /test e2e-aws-console-olm
ci/prow/e2e-aws-olm f7214b2 link /test e2e-aws-olm

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@pierreozoux
Copy link

Too bad this didn't land upstream ;) I also have stuck namespace..

@dhrp
Copy link

dhrp commented Mar 1, 2020

I can confirm this worked for me on Kubernetes, it got me out of the stuck namespace problem.

@zzztimbo
Copy link

Why wasn't this merged?

@openshift-ci-robot openshift-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 11, 2020
@openshift-ci-robot
Copy link
Collaborator

@camilamacedo86: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@camilamacedo86
Copy link
Contributor Author

camilamacedo86 commented Apr 11, 2020

hi @ecordell,

Shows that it has been util for the users, so I rebased with the master and re-opened it.
See: #1438

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants