-
Notifications
You must be signed in to change notification settings - Fork 562
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
camilamacedo86
wants to merge
4
commits into
operator-framework:master
from
camilamacedo86:uninstall
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
83ad884
feat(Makefile) : Organize install commands and add uninstall
camilamacedo86 562c352
feat(github) : Add github files in order to follow org standard
camilamacedo86 904e268
doc(Readme/Install) : Organize information in order to make more unde…
camilamacedo86 f7214b2
feat(README) : Update info regards subscription and to address the us…
camilamacedo86 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,5 @@ | ||
<!--- | ||
Thanks for filing an issue! Before you submit, please read the following: | ||
|
||
Check the other issue templates if you are trying to submit a bug report, feature request, or question. Search open/closed issues before submitting since someone might have asked the same thing before! | ||
--> |
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,50 @@ | ||
--- | ||
name: Bug Report | ||
about: If things aren't working as expected. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Bug Report | ||
|
||
<!-- | ||
Note: Make sure to first check the prerequisites that can be found in the main README file! | ||
|
||
Thanks for filing an issue! Before hitting the button, please answer these questions. | ||
Fill in as much of the template below as you can. If you leave out information, we can't help you as well. | ||
--> | ||
|
||
**What did you do?** | ||
A clear and concise description of the steps you took (or insert a code snippet). | ||
|
||
**What did you expect to see?** | ||
A clear and concise description of what you expected to happen (or insert a code snippet). | ||
|
||
**What did you see instead? Under which circumstances?** | ||
A clear and concise description of what you expected to happen (or insert a code snippet). | ||
|
||
|
||
**Environment** | ||
* operator-lifecycle-manager version: | ||
|
||
<!--- Insert operator-lifecycle-manager release or Git SHA here. --> | ||
|
||
* go version: | ||
|
||
<!--- Insert the output of `go version` here --> | ||
|
||
* Kubernetes version information: | ||
|
||
<!--- Insert the output of `kubectl version` here --> | ||
|
||
* Kubernetes cluster kind: | ||
|
||
* Are you writing your operator in ansible, helm, or go? | ||
|
||
**Possible Solution** | ||
<!--- Only if you have suggestions on a fix for the bug --> | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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,16 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest a feature | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Feature Request | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Example: "I have an issue when (...)" | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. Add any considered drawbacks. |
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,48 @@ | ||
--- | ||
name: Support Question | ||
about: Any support questions you might have. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- | ||
Thanks for filing an issue! Before hitting the button, please answer these questions. | ||
|
||
Fill in as much of the template below as you can. If you leave out information, we can't help you as well. | ||
|
||
We will try our best to answer the question, but we also have a mailing list and slack channel for any other questions. | ||
--> | ||
|
||
## Type of question | ||
|
||
**Are you asking about community best practices, how to implement a specific feature, or about general context and help around the operator-sdk?** | ||
|
||
|
||
## Question | ||
|
||
**What did you do?** | ||
A clear and concise description of the steps you took (or insert a code snippet). | ||
|
||
**What did you expect to see?** | ||
A clear and concise description of what you expected to happen (or insert a code snippet). | ||
|
||
**What did you see instead? Under which circumstances?** | ||
A clear and concise description of what you expected to happen (or insert a code snippet). | ||
|
||
|
||
**Environment** | ||
* operator-lifecycle-manager version: | ||
|
||
<!--- Insert operator-lifecycle-manager release or Git SHA here. --> | ||
|
||
* Kubernetes version information: | ||
|
||
<!--- insert output of `kubectl version` here. --> | ||
|
||
|
||
* Kubernetes cluster kind: | ||
|
||
**Additional context** | ||
Add any other context about the question here. |
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,19 @@ | ||
<!-- | ||
|
||
Before making a PR, please read our contributing guidelines https://github.com/operator-framework/operator-lifecycle-manager/blob/master/CONTRIBUTING.MD | ||
|
||
Note: Make sure your branch is rebased to the latest upstream master. | ||
|
||
--> | ||
|
||
**Description of the change:** | ||
|
||
|
||
**Motivation for the change:** | ||
|
||
<!-- | ||
|
||
Note: If this PR is fixing an issue make sure to add a note saying: | ||
Closes #<ISSUE_NUMBER> | ||
|
||
--> |
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,69 @@ | ||
# How to contribute | ||
|
||
Operator Lifecycle Manager is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into operator-lifecycle-manager. | ||
|
||
# Email and Chat | ||
|
||
- Email: [operator-framework][operator_framework] | ||
|
||
## Getting started | ||
|
||
- Fork the repository on GitHub | ||
- See the [developer guide](./doc/dev/developer_guide.md) for build instructions | ||
|
||
## Reporting bugs and creating issues | ||
|
||
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](./doc/dev/reporting_bugs.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug. | ||
|
||
## Contribution flow | ||
|
||
This is a rough outline of what a contributor's workflow looks like: | ||
|
||
- Create a topic branch from where to base the contribution. This is usually master. | ||
- Make commits of logical units. | ||
- Make sure commit messages are in the proper format (see below). | ||
- Push changes in a topic branch to a personal fork of the repository. | ||
- Submit a pull request to operator-framework/operator-sdk. | ||
- The PR must receive a LGTM from two maintainers found in the MAINTAINERS file. | ||
|
||
Thanks for contributing! | ||
|
||
### Code style | ||
|
||
The coding style suggested by the Golang community is used in operator-sdk. See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details. | ||
|
||
Please follow this style to make operator-sdk easy to review, maintain and develop. | ||
|
||
### Format of the commit message | ||
|
||
We follow a rough convention for commit messages that is designed to answer two | ||
questions: what changed and why. The subject line should feature the what and | ||
the body of the commit should describe the why. | ||
|
||
``` | ||
scripts: add the test-cluster command | ||
|
||
this uses tmux to setup a test cluster that can easily be killed and started for debugging. | ||
|
||
Fixes #38 | ||
``` | ||
|
||
The format can be described more formally as follows: | ||
|
||
``` | ||
<subsystem>: <what changed> | ||
<BLANK LINE> | ||
<why this change was made> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
|
||
The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools. | ||
|
||
## Documentation | ||
|
||
If the contribution changes the existing APIs or user interface it must include sufficient documentation to explain the use of the new or updated feature. Likewise the [CHANGELOG][changelog] should be updated with a summary of the change and link to the pull request. | ||
|
||
|
||
[operator_framework]: https://groups.google.com/forum/#!forum/operator-framework | ||
[changelog]: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/CHANGELOG.md |
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 |
---|---|---|
|
@@ -84,6 +84,7 @@ run-local: build-linux build-wait | |
. ./scripts/install_local.sh $(LOCAL_NAMESPACE) build/resources | ||
rm -rf build | ||
|
||
|
||
deploy-local: | ||
mkdir -p build/resources | ||
. ./scripts/package_release.sh 1.0.0 build/resources Documentation/install/local-values.yaml | ||
|
@@ -229,11 +230,54 @@ ifeq ($(quickstart), true) | |
./scripts/package_quickstart.sh deploy/$(target)/manifests/$(ver) deploy/$(target)/quickstart/olm.yaml deploy/$(target)/quickstart/crds.yaml deploy/$(target)/quickstart/install.sh | ||
endif | ||
|
||
########################## | ||
# OLM - Commands # | ||
########################## | ||
################################ | ||
# OLM - Install/Uninstall/Run # | ||
################################ | ||
|
||
.PHONY: run-console-local | ||
run-console-local: | ||
@echo Running script to run the OLM console locally: | ||
. ./scripts/run_console_local.sh | ||
|
||
.PHONY: uninstall | ||
uninstall: | ||
@echo Uninstalling OLM: | ||
- kubectl delete -f deploy/upstream/quickstart/crds.yaml | ||
- kubectl delete -f deploy/upstream/quickstart/olm.yam | ||
- kubectl delete catalogsources.operators.coreos.com | ||
- kubectl delete clusterserviceversions.operators.coreos.com | ||
- kubectl delete installplans.operators.coreos.com | ||
- kubectl delete operatorgroups.operators.coreos.com subscriptions.operators.coreos.com | ||
- kubectl delete apiservices.apiregistration.k8s.io v1.packages.operators.coreos.com | ||
- kubectl delete ns olm | ||
- kubectl delete ns openshift-operator-lifecycle-manager | ||
- kubectl delete ns openshift-operators | ||
- kubectl delete ns operators | ||
- kubectl delete clusterrole.rbac.authorization.k8s.io/aggregate-olm-edit | ||
- kubectl delete clusterrole.rbac.authorization.k8s.io/aggregate-olm-view | ||
- kubectl delete clusterrole.rbac.authorization.k8s.io/system:controller:operator-lifecycle-manager | ||
- kubectl delete clusterroles.rbac.authorization.k8s.io "system:controller:operator-lifecycle-manager" | ||
- kubectl delete clusterrolebindings.rbac.authorization.k8s.io "olm-operator-binding-openshift-operator-lifecycle-manager" | ||
|
||
.PHONY: run-local | ||
run-local: build-linux | ||
@echo Building OLM: | ||
rm -rf build | ||
. ./scripts/build_local.sh | ||
mkdir -p build/resources | ||
. ./scripts/package_release.sh 1.0.0 build/resources Documentation/install/local-values.yaml | ||
. ./scripts/install_local.sh local build/resources | ||
rm -rf build | ||
|
||
.PHONY: install-crd | ||
install-crd: | ||
@echo Applying upstream quick start crd ... | ||
- kubectl apply -f deploy/upstream/quickstart/crds.yaml | ||
- kubectl apply -f deploy/upstream/quickstart/olm.yaml | ||
|
||
.PHONY: install-ocp | ||
install-ocp: | ||
@echo Applying latest ... | ||
- kubectl create -f deploy/ocp/manifests/latest/ | ||
camilamacedo86 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
@echo Adding cluster-admin permissions to system:serviceaccount:kube-system:default... | ||
- oc adm policy add-cluster-role-to-user cluster-admin system:serviceaccount:kube-system:default | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is this clusterrolebinding needed? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To allow use it with Minishift. |
Oops, something went wrong.
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.
I'm not sure we should have this - OLM is already in OCP
Uh oh!
There was an error while loading. Please reload this page.
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.
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.