Fix installed plugins to use a dedicated dir to prevent naming conflict

[PhillypHenning]

Description

Updating where plugins are installed by updating the path that is used.

fixes #339

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• Documentation update

How Has This Been Tested?

I tested this locally, proof is in the issue ticket.

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

[mickmcgrath13]

set to "request changes" to remove the schema config reference

Also, we'll probably want to check to be sure that all plugins that reference other plugins (helm references aws and kubectl, for example) are doing so via the $BITOPS_PLUGINS_DIR env var)

[PhillypHenning]

Plugin confirmed usage of BITOPS_PLUGINS_DIR

• Cloudformation
• Helm

Plugins confirmed not to use BITOPS_PLUGINS_DIR or /scripts/plugin

• Terraform
• Ansible
• kubectl
• aws

[arm4b]

This variable is used only once. We could remove the unneeded variable assignment from this line:

Suggested change

bitops_plugins_dir = BITOPS_plugin_dir

and use the original BITOPS_plugin_dir var later below:

bitops/scripts/plugins/deploy_plugins.py

Line 113 in d71a36e

\n\t BITOPS_PLUGIN_DIR: [{bitops_plugins_dir}] \

that will keep vars a bit cleaner in this function.

[PhillypHenning]

Testing

docker run --rm -it --entrypoint bash bitops:latest

bash-5.0# ls -al /opt/bitops/scripts/
total 32
drwxr-xr-x    1 root     root          4096 Nov 21 16:54 .
drwxr-xr-x    1 root     root          4096 Nov 21 16:54 ..
drwxr-xr-x    2 root     root          4096 Nov 21 16:54 ci
drwxr-xr-x    8 root     root          4096 Nov 21 16:55 installed_plugins
-rwxr-xr-x    1 root     root          1838 Nov 10 17:09 main.py
drwxr-xr-x    1 root     root          4096 Nov 21 16:54 plugins

bash-5.0# ls -al /opt/bitops/scripts/installed_plugins/
total 36
drwxr-xr-x    8 root     root          4096 Nov 21 16:55 .
drwxr-xr-x    1 root     root          4096 Nov 21 16:54 ..
drwxr-xr-x    4 root     root          4096 Nov 21 16:55 ansible
drwxr-xr-x    3 root     root          4096 Nov 21 16:54 aws
drwxr-xr-x    4 root     root          4096 Nov 21 16:54 cloudformation
drwxr-xr-x    4 root     root          4096 Nov 21 16:54 helm
drwxr-xr-x    4 root     root          4096 Nov 21 16:54 kubectl
drwxr-xr-x    4 root     root          4096 Nov 21 16:54 terraform

[arm4b]

If we agreed to not expose the configuration for this setting via bitops.config.yaml, can we exclude setting it from the ENV var as a source too?

That's again for the reasons of simplicity and avoiding exposing configuration that's not needed by the user.

[PhillypHenning]

Right but plugin scripts directly use this env var ...

[arm4b]

The exporting for the plugins looks fine.

But here we're importing the ENV var from the user's side. This could be removed as we don't want users to override this setting.

[arm4b]

This would make BITOPS_INSTALLED_PLUGIN_DIR = /opt/bitops/scripts/installed_plugins/ a constant.

[PhillypHenning]

Gotcha 👍 Will fix this after lunch

[arm4b]

Looks good 👍
Thanks for all the changes!

The requested change to remove the config parameter was addressed