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

ocdb-cli and ocdb registry #13

Open
omenking opened this issue Jan 7, 2023 · 1 comment
Open

ocdb-cli and ocdb registry #13

omenking opened this issue Jan 7, 2023 · 1 comment

Comments

@omenking
Copy link
Contributor

omenking commented Jan 7, 2023

Tell me how dumb this and out-of-scope but is an idea I'd like to share:

Components

  • Feature - a git repo containing how to configure and install an individual component configuration
  • Package - a json/yaml file that says what features are included

Open Cloud Dev Box (OCDB) CLI

Examples of the CLI:

ocdb-cli --target="gitpod" --features=["omenking/aws-cli","openupthecloud/gcpcloud","<git url>"]
ocdb-cli --target="gitpod" --package-file-json=file://gitpod-aws-begginer.json
ocdb-cli --target="gitpod" --package-file-yaml=file://gitpod-aws-begginer.yaml
ocdb-cli --target="gitpod-dockerfile" --package-file-yaml=file://gitpod-aws-cloudbootcamp.yaml
ocdb-cli --target="gitpod-dockerfile" --package-file-yaml=<any url that points to a json yaml file>

OCDB Feature Registry

The OCDB registry is an approved list of repos.
This can be represented as simply a json file hosted at this current repo that is used by the CLI eg:

{
  "omenking/aws-cli" : "<git url>", "author": "Andrew Brown",
}

So when specific a feature/module you can then just use the short form eg. omenking/aws-cli instead of the whole url.

Feature Repo Structure

Repos should follow a convention and require they repo name be prefiex with ocdb- eg. https://github.com/omenking/ocdb-aws-cli

Package File

{
  "features": [
    "omenking/aws-cli",
    "aws/aws-copilot",
    "aws/dynamodb-local",
    "<git url>"
  ]
}
@loujaybee
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants