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

Common README information #52

Merged
merged 1 commit into from
Oct 11, 2019

Conversation

sallyom
Copy link
Contributor

@sallyom sallyom commented Sep 27, 2019

This strays from the template for enhancements. Also, this is aimed for developers who can access images from registry.svc.ci.openshift.org registry.

The goal of this is a doc that can be linked to in many openshift/repos READMEs.
This contains common info wrt 'What is an operator (mostly specific to OpenShift)?' and 'How do I build/deploy/update/ this code?'

@openshift-ci-robot openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 27, 2019
@sallyom sallyom force-pushed the operator-dev-docs branch 7 times, most recently from a5f2b6b to 7566a92 Compare September 28, 2019 20:28
@openshift-ci-robot openshift-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 28, 2019
@sallyom sallyom force-pushed the operator-dev-docs branch 18 times, most recently from 7cfedbe to c4ad2e6 Compare September 28, 2019 23:34
@sallyom sallyom force-pushed the operator-dev-docs branch 7 times, most recently from de227d5 to 3915493 Compare October 10, 2019 20:27
@sallyom
Copy link
Contributor Author

sallyom commented Oct 10, 2019

@deads2k @marun @soltysh i've addressed your suggestions

@sallyom
Copy link
Contributor Author

sallyom commented Oct 10, 2019

a few issues with imagebuilder/make images:

  1. authorization is broken
  2. symlink handling issue
  3. once worked around those, the make images produces an image named like
    registry.svc.ci.openshift.org/ocp/4.2:cluster-config-operator rather than the necessary
    quay.io/sallyom/mytestimage:test so you'd need another tag step, anyways, and that makes the buildah/docker route simpler.

For those reasons, the doc outlines how to develop w/ buildah/docker cmds, with a note about make images Will work on fixing up imagebuilder and it's call in library-go when we have the time.


If the above command fails, you need to authenticate against `registry.svc.ci.openshift.org`.
Add the necessary credentials to your local `~/.docker/config.json` (or equivalent file) like so:
- visit `https://api.ci.openshift.org`, `upper right corner '?'` dropdown to `Command Line Tools`
Copy link

Choose a reason for hiding this comment

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

Too much detail, imo.

*Dockerfile name varies per repository, this example used Dockerfile.rhel, but it may have a different name*
```
$ cd local/path/to/openshift-apiserver
$ buildah bud -f path/to/Dockerfile.rhel -t quay.io/yourname/openshift-apiserver:test .
Copy link

Choose a reason for hiding this comment

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

I'm still missing make images here, even though it has problems, I'd prefer we use that.

*Dockerfile name varies per repository, this example used Dockerfile.rhel, but it may have a different name*
```
$ cd local/path/to/openshift-apiserver
$ buildah bud -f path/to/Dockerfile.rhel -t quay.io/yourname/openshift-apiserver:test .
Copy link

Choose a reason for hiding this comment

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

We can mention the problems, and how to solve them, but still use that. For that .dockeringonre we need to ensure to add it where necessary.

@sallyom sallyom force-pushed the operator-dev-docs branch 11 times, most recently from 899a921 to 9715df6 Compare October 11, 2019 16:38
@deads2k
Copy link
Contributor

deads2k commented Oct 11, 2019

good to start

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 11, 2019
@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deads2k, sallyom

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-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 11, 2019
@openshift-merge-robot openshift-merge-robot merged commit d8a4786 into openshift:master Oct 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. 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