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

Local plugin install #349

Merged
merged 17 commits into from
Dec 20, 2022
Merged

Local plugin install #349

merged 17 commits into from
Dec 20, 2022

Conversation

mickmcgrath13
Copy link
Contributor

@mickmcgrath13 mickmcgrath13 commented Nov 7, 2022

Description

Introduces the functionality to use file:// for BitOps configs when building your own BitOps image to use locally-developed plugins.

It works by providing a plugins directory as a sibling directory to the Dockerfile (required for Docker build accessibility). When a plugins/ directory exists, the Docker ONBUILD directives will copy the contents into the container at /opt/bitops-local-plugins. From there, the BitOps-level bitops.config.yaml can reference the plugin like:

bitops:
  # ...other stuff
  plugins:    
    duplicate-environment:
      source: file:///opt/bitops-local-plugins/my-plugin
  deployments:
    my-plugin:
      plugin: my-plugin

Closes #308

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

See the docs included in the PR. Tested with both local (file://) plugin references as well as URL based.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

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

Looked quickly, nice stuff! 💯

Will try the whole new experience end-to-end later.

scripts/plugins/install_plugins.py Outdated Show resolved Hide resolved
scripts/plugins/install_plugins.py Show resolved Hide resolved
scripts/plugins/install_plugins.py Outdated Show resolved Hide resolved
@arm4b arm4b added this to the v2.2.0 milestone Nov 8, 2022
docs/development/local-plugin-creation.md Outdated Show resolved Hide resolved
docs/development/local-plugin-creation.md Outdated Show resolved Hide resolved
docs/development/local-plugin-creation.md Outdated Show resolved Hide resolved
docs/development/local-plugin-creation.md Outdated Show resolved Hide resolved
docs/development/local-plugin-creation.md Outdated Show resolved Hide resolved
@arm4b arm4b modified the milestones: v2.2.0, v2.3.0 Nov 21, 2022
mickmcgrath13 and others added 7 commits December 19, 2022 10:11
fix plugin source path check to handle relative dir

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
fix plurality and specify remote source type

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
use dev tag for local dev

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
remove pythonunbuffered flag from docker run example

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
docs/plugins.md Show resolved Hide resolved
fix casing in schema

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
mickmcgrath13 and others added 4 commits December 19, 2022 14:29
fix path to installed plugins in local-plugin-create

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
I thought we did this one already.. :)

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
update ref to plugin installation path

Co-authored-by: Eugen C. <1533818+armab@users.noreply.github.com>
Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

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

LGTM

@arm4b arm4b merged commit 60a5508 into main Dec 20, 2022
@arm4b arm4b deleted the local-plugin-install branch December 20, 2022 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Local Plugin Development and Testing
3 participants