[REPOSITORY] Egeria Notebooks

[planetf1]

Name

egeria-jupyter-notebooks

Owner

planetf1, mandy_chessell

Deliverable

Provides Jupyter notebooks used for Egeria tutorials

Build, test and CI-CD process

The notebooks are currently in open-metadata-resources/open-metadata-labs.
They would be moved over (and later removed from core egeria).

We will no longer build a container with these notebooks, but rather access directly from github (copied into jupyter under control of our helm charts)

That copy will use either a specific SHA to refer to a consistent version as tested for a release, or we may implement a tagging or release process

• SHA - lightweight, no build work needed
• Tag - still fairly lightweight, clearer identity
• release - clearer still, easier to download a bundle
• branch & release - can maintain a service stream

Therefore there is no ci/cd process (automated test/verification is a future option)

odpi/egeria-coco-labs#4 will track the specific migration of the code, removal from old repository, changes to charts, containers etc

Dependencies

Affects

• egeria (source for the notebooks, jupyter container image)
• egeria-charts (the lab chart requires these notebooks)

Justification

Continue splitting out egeria assets into logical units to make them easier to work with - by creators & consumers.

Assumptions

yes - true

Additional Information

No response

Work Plan

Before creating the repo

• review overall request & get clarifications
• get approval on developer/TSC call from maintainers

Creating the repo

• Create the repo under the odpi organization (default gitignore, license, readme)
• Setup branch protection rules
• Set pull request options (allow merge, squash, rebase, suggest updating, allow automerge, do not delete head)
• Update security settings in repo (policy, advisories, alerts)
• set up permissions

First steps

• Initial code-drop (author)

Getting CI/CD started & refining settings

• Add initial build script for PR (including gradle wrapper if required)
• Add initial build script for merge

Further Refinement

• Add link in egeria docs to new repo describing purpose ( https://github.com/odpi/egeria-docs/blob/main/site/docs/education/tutorials/git-and-git-hub-tutorial/egeria-git-repositories.md )
• Add to connector catalog, if new repo is for connector ( https://github.com/odpi/egeria-docs/blob/main/site/docs/connectors/index.md )
• Add to release process docs ( https://github.com/odpi/egeria-docs/blob/main/site/docs/guides/contributor/release-process/index.md )
• Add required credentials for publishing to container repos, maven central etc
• Add artifact signing if needed
• Add dependabot config
• Add CodeQL
• Add to LFX ( https://projectadmin.lfx.linuxfoundation.org/project/a092M00001IV4JtQAL ) for
  • LFXSecurity
  • LFAnalytics
• Add check for stale defects
• Add any required issue tags

Release

• Add release pipeline

[planetf1]

This was agreed on a recent developer call

[planetf1]

remaining work is documentation so moving there