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.

Sign up for GitHub

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

Jump to bottom

docs: Provide operatorhub.io installation instructions #889

Merged
merged 4 commits into from
Apr 14, 2022
Merged

docs: Provide operatorhub.io installation instructions #889

merged 4 commits into from
Apr 14, 2022

Conversation

jhrozek
Copy link
Contributor

@jhrozek jhrozek commented Apr 7, 2022

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Now that SPO exists on operatorhub.io, make sure we tell people how to
use it.

Which issue(s) this PR fixes:

Fixes #779

Does this PR have test?

N/A

Special notes for your reviewer:

Tested on our vagrant fedora image.

Does this PR introduce a user-facing change?

It is now possible to install SPO from packages provided on operatorhub.io. User-facing documentation
is provided in the installation-usage.md document.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 7, 2022
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 7, 2022
saschagrunert
saschagrunert approved these changes Apr 7, 2022
View reviewed changes
Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

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

LGTM

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Apr 7, 2022
@jhrozek
Copy link
Contributor Author

jhrozek commented Apr 7, 2022

@saschagrunert I'm sorry to have invalidated the lgtm tag, but I also added instructions on using the upstream bundles. This is mainly useful for people wanting to test the latest code. See also one question inline

jhrozek
jhrozek commented Apr 7, 2022
View reviewed changes
examples/olm/install-resources.yaml
@@ -12,7 +12,7 @@ metadata:
namespace: olm
spec:
sourceType: grpc
image: quay.io/security-profiles-operator/security-profiles-operator-catalog:latest
image: gcr.io/k8s-staging-sp-operator/security-profiles-operator-catalog:latest
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@saschagrunert Should I also amend release.md or some release script so that these are kept in sync when we do a release?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, definitely 👍

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 7, 2022
@codecov-commenter
Copy link

codecov-commenter commented Apr 7, 2022 •
edited
Loading

Codecov Report

Merging #889 (106eddf) into main (de3017a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #889   +/-   ##
=======================================
  Coverage   50.99%   50.99%           
=======================================
  Files          42       42           
  Lines        4536     4536           
=======================================
  Hits         2313     2313           
  Misses       2142     2142           
  Partials       81       81

@saschagrunert
Copy link
Member

/test pull-security-profiles-operator-test-e2e

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 10, 2022
@jhrozek
Copy link
Contributor Author

jhrozek commented Apr 10, 2022

I amended the release doc in this PR since the tests needed a re-run anyway :-)

@saschagrunert
Copy link
Member

/test pull-security-profiles-operator-test-e2e

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 11, 2022
@jhrozek
docs: Provide operatorhub.io installation instructions
fadffbe 
Now that SPO exists on operatorhub.io, make sure we tell people how to
use it.
@jhrozek
examples: Point to gcr.io/k8s-staging-sp-operator/security-profiles-o…
c752708 
…perator-catalog:latest

The example was pointing to a nonexistent catalog. Let's use the catalog
that is refreshed after every build instead.
@jhrozek
doc: Also document using the upstream catalog and bundle
e4cc399 
This is mostly useful for anyone testing nightlies.
@jhrozek
doc: Amend release.md to note that the OLM manifests must also be cha…
850082c 
…nged

The OLM manifests at examples/olm/install-resources.yaml contain
unversioned image tags, but at the release time they should contain the
release tag.
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 13, 2022
@jhrozek
Copy link
Contributor Author

jhrozek commented Apr 13, 2022

Rebased on master in hopes of getting a clean CI run

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 14, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhrozek, saschagrunert

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:
  • OWNERS [jhrozek,saschagrunert]

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

@saschagrunert
Copy link
Member

Merging to save the environment.

@saschagrunert saschagrunert merged commit 0869387 into kubernetes-sigs:main Apr 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saschagrunert saschagrunert saschagrunert approved these changes

@cmurphy cmurphy Awaiting requested review from cmurphy

Assignees

@saschagrunert saschagrunert

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bring the SPO to operatorhub.io
4 participants
@jhrozek @codecov-commenter @saschagrunert @k8s-ci-robot