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

add runtime Docker image creation doc #915

Merged
merged 8 commits into from
Sep 16, 2020
Merged

add runtime Docker image creation doc #915

merged 8 commits into from
Sep 16, 2020

Conversation

ptitzler
Copy link
Member

@ptitzler ptitzler commented Sep 8, 2020

This PR

  • Adds documentation that outlines how to create and publish a Docker image that meets the notebook pipelines runtime image prerequisites. In addition it documents important considerations for certain use-case scenarios. Wherever appropriate, the doc includes links to the relevant Docker documentation, such as the Docker commands and Dockerfile instructions.
  • Adds links to the new documentation.

Closes #910

Developer's Certificate of Origin 1.1

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

@ptitzler ptitzler added area:documentation Improvements or additions to documentation status:Work in Progress Development in progress. A PR tagged with this label is not review ready unless stated otherwise. labels Sep 8, 2020
@ptitzler ptitzler marked this pull request as draft September 8, 2020 16:56
@ptitzler

This comment has been minimized.

@ptitzler ptitzler marked this pull request as ready for review September 9, 2020 16:11
@ptitzler ptitzler removed the status:Work in Progress Development in progress. A PR tagged with this label is not review ready unless stated otherwise. label Sep 9, 2020
@ptitzler
Copy link
Member Author

ptitzler commented Sep 9, 2020

Tested the instructions and scenarios:

  • published a Docker image for each CMD-based scenario
  • added a runtime image configuration for each docker image
  • published a Docker image for each ENTRYPOINT-based scenario
  • verified that pipeline output matches the documented behavior for each scenario

@ptitzler
Copy link
Member Author

ptitzler commented Sep 9, 2020

Not totally sure what the difference is between a recipe and a user guide in the Elyra documentation. That said, I've added the doc as a recipe. If that was the wrong thing to do then I'll reclassify it as a user guide contrbution.

image

@ptitzler ptitzler added the kind:enhancement New feature or request label Sep 9, 2020
@lresende lresende merged commit b90deac into elyra-ai:master Sep 16, 2020
@lresende lresende added this to the 1.2.0 milestone Sep 16, 2020
@ptitzler ptitzler deleted the i910 branch December 14, 2020 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Improvements or additions to documentation kind:enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to create a Docker image that can be used as a runtime environment
3 participants