documentation for new OLM command workflows

operator-framework / enhancements

Apache License 2.0

9 stars 40 forks source link

documentation for new OLM command workflows #16

Closed varshaprasad96 closed 4 years ago

varshaprasad96 commented 4 years ago

This PR provides documentation explaining the workflows for proposed OLM commands with Operator SDK and a README describing the deployment of operator by following the suggested workflows.

varshaprasad96 commented 4 years ago

@jmrodri @estroz @joelanford @dmesser - I have moved the PR (https://github.com/operator-framework/operator-sdk/pull/2834) from Operator SDK to this repo. Please provide your inputs.

varshaprasad96 commented 4 years ago

Updated the PR with man page for commands.

camilamacedo86 commented 4 years ago

/lgtm

camilamacedo86 commented 4 years ago

/approve

varshaprasad96 commented 4 years ago

Updated the doc based on reviews.

estroz commented 4 years ago

This PR has been updated to a full EP.

/cc @varshaprasad96 @jmrodri

openshift-ci-robot commented 4 years ago

@estroz: GitHub didn't allow me to request PR reviews from the following users: varshaprasad96.

Note that only operator-framework members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to [this](https://github.com/operator-framework/enhancements/pull/16#issuecomment-631103980): >This PR has been updated to a full EP. > >/cc @varshaprasad96 @jmrodri Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

estroz commented 4 years ago

In https://github.com/operator-framework/operator-sdk/pull/2860 I changed init behavior so that it scaffolds config/bundle/kustomization.yaml instead of generate bundle --kustomize, which I haven't yet added to this EP.

My reasoning for this change: why would you use operator-sdk if you did not want bundle/packagemanifests features? Just use vanilla kubebuilder instead. Thoughts on this?

estroz commented 4 years ago

@camilamacedo86 @shawn-hurley @joelanford @hasbro17 I removed the manifests recipe modification and changed packagemanifests -> package.

jmccormick2001 commented 4 years ago

is the convention normally "operator-sdk