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

Epic: Document Advanced Dependencies #2606

Open
13 tasks
Tracked by #2668
carolynvs opened this issue Feb 28, 2023 · 0 comments
Open
13 tasks
Tracked by #2668

Epic: Document Advanced Dependencies #2606

carolynvs opened this issue Feb 28, 2023 · 0 comments
Assignees
Labels
docs Markdown ahoy! Updates needed on porter.sh or in dev docs. pep003-advanced-dependencies Implementation of the Advanced Dependencies proposal placeholder Tracks work that has not yet be fully designed

Comments

@carolynvs
Copy link
Member

carolynvs commented Feb 28, 2023

Start a new page to document how dependencies v2 work (conceptual docs, task, etc) but flag that it's not implemented yet. Do not update the existing page since that needs to stay the same to support the current implementation.

TODO: Split these into separate issues

  • Update CNAB Support Page with Dependencies v2
  • Concept Doc: Dependencies
    • Include use cases and pictures and yaml snippets from the proposal
  • Concept Doc: Bundle Interfaces
    • mention well-known interfaces and link
    • Link to provider independent bundles
  • Concept Doc: Bundle Composition
    • meta bundles
  • Concept Doc: Solve Bundle Dependency Graph
    • Should the docs that go into implementation details be reference docs?
  • Concept Doc: Workflows
  • Concept Doc: Execution Plans
  • Concept Doc: Well-Known Bundle Interfaces
    • link to task for multi-provider bundle (wordpress)
  • Concept Doc: Multi-cloud Bundles
    • pick a name and stick with it: provider independent, multi-provider, generic bundles... whatever
  • Task Doc: Depend on another bundle
    • graph
    • default implementation
    • passing data
  • Task Doc: Install a bundle on multiple cloud providers
    • provider independent bundles
    • bundle interfaces
    • wordpress bundle example with redis, k8s and mysql
  • Task Doc: Move a bundle across an airgap
    • the existing doc at https://getporter.org/administrators/airgap/ is a concept doc and should be moved
    • Update existing doc with info about how deps are moved and relocated, including bundle interfaces, default implementations
    • Include in the task doc moving a simple bundle and a bundle with dependencies that have default implementations
  • Example Doc: Deploy Bundles with Generic Dependencies in an Airgapped Environment
    • Wordpress example bundle
    • Make a new example bundle that has dependencies with default implementations (voter app)

ℹ️ Read PEP003 - Advanced Dependencies for context about how dependencies should work, design details, and notes about desired behavior.

@carolynvs carolynvs added docs Markdown ahoy! Updates needed on porter.sh or in dev docs. pep003-advanced-dependencies Implementation of the Advanced Dependencies proposal labels Feb 28, 2023
@carolynvs carolynvs self-assigned this Feb 28, 2023
@carolynvs carolynvs added the placeholder Tracks work that has not yet be fully designed label Mar 31, 2023
@carolynvs carolynvs changed the title Document dependencies v2 Epic: Document Advanced Dependencies Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Markdown ahoy! Updates needed on porter.sh or in dev docs. pep003-advanced-dependencies Implementation of the Advanced Dependencies proposal placeholder Tracks work that has not yet be fully designed
Projects
No open projects
Status: No status
Development

No branches or pull requests

1 participant