Merge pull request #123 from nautobot/u/whitej6-renaming

Renaming work

.cookiecutter.json

@@ -4,16 +4,16 @@
         "full_name": "Network to Code, LLC",
         "email": "[email protected]",
         "github_org": "nautobot",
-        "plugin_name": "nautobot_secrets_providers",
-        "verbose_name": "Nautobot's Secrets Providers Plugin",
-        "plugin_slug": "nautobot-secrets-providers",
-        "project_slug": "nautobot-plugin-secrets-providers",
-        "repo_url": "https://github.com/nautobot/nautobot-plugin-secrets-providers",
+        "app_name": "nautobot_secrets_providers",
+        "verbose_name": "Nautobot's Secrets Providers App",
+        "app_slug": "nautobot-secrets-providers",
+        "project_slug": "nautobot-app-secrets-providers",
+        "repo_url": "https://github.com/nautobot/nautobot-app-secrets-providers",
         "base_url": "secrets-providers",
         "min_nautobot_version": "2.0.0",
         "max_nautobot_version": "2.9999",
         "camel_name": "NautobotSecretsProviders",
-        "project_short_description": "Nautobot's Secrets Providers Plugin",
+        "project_short_description": "Nautobot's Secrets Providers App",
         "model_class_name": "None",
         "open_source_license": "Apache-2.0",
         "docs_base_url": "https://docs.nautobot.com",
@@ -33,3 +33,4 @@
         }
     }
 }
+

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -31,5 +31,5 @@
 - [ ] Attached Screenshots, Payload Example
 - [ ] Unit, Integration Tests
 - [ ] Documentation Updates (when adding/changing features)
-- [ ] Example Plugin Updates (when adding/changing features)
+- [ ] Example App Updates (when adding/changing features)
 - [ ] Outline Remaining Work, Constraints from Design

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ on: # yamllint disable-line rule:truthy rule:comments
   pull_request: ~
 
 env:
-  PLUGIN_NAME: "nautobot-plugin-secrets-providers"
+  APP_NAME: "nautobot-app-secrets-providers"
 
 jobs:
   black:
@@ -116,7 +116,7 @@ jobs:
           context: "./"
           push: false
           load: true
-          tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           file: "./development/Dockerfile"
           cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
@@ -159,7 +159,7 @@ jobs:
           context: "./"
           push: false
           load: true
-          tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           file: "./development/Dockerfile"
           cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
@@ -206,7 +206,7 @@ jobs:
           context: "./"
           push: false
           load: true
-          tags: "${{ env.PLUGIN_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
+          tags: "${{ env.APP_NAME }}/nautobot:${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           file: "./development/Dockerfile"
           cache-from: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"
           cache-to: "type=gha,scope=${{ matrix.nautobot-version }}-py${{ matrix.python-version }}"

.github/workflows/upstream_testing.yml

@@ -10,4 +10,4 @@ jobs:
     uses: "nautobot/nautobot/.github/workflows/plugin_upstream_testing_base.yml@develop"
     with:  # Below could potentially be collapsed into a single argument if a concrete relationship between both is enforced
       invoke_context_name: "NAUTOBOT_SECRETS_PROVIDERS"
-      plugin_name: "nautobot-plugin-secrets-providers"
+      plugin_name: "nautobot-app-secrets-providers"

CHANGELOG.md

@@ -4,81 +4,81 @@
 
 ### Added
 
-- [#113](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/113) Added the missing fix for [issue](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/91) that was not included for v2.0.0
+- [#113](https://github.com/nautobot/nautobot-app-secrets-providers/pull/113) Added the missing fix for [issue](https://github.com/nautobot/nautobot-app-secrets-providers/issues/91) that was not included for v2.0.0
 
 ## v2.0.0 (2023-09-23)
 
 ### Changed
 
-- [#105](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/106) Updated `nautobot` to `2.0`.
+- [#105](https://github.com/nautobot/nautobot-app-secrets-providers/pull/106) Updated `nautobot` to `2.0`.
 
 ### Removed
 
-- [#105](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/106) Removed `slug` field from `Secret` model. Can be replaced with `name` field or [natural keys](https://docs.nautobot.com/projects/core/en/next/development/apps/migration/model-updates/global/#replace-the-usage-of-slugs-with-composite-keys).
+- [#105](https://github.com/nautobot/nautobot-app-secrets-providers/pull/106) Removed `slug` field from `Secret` model. Can be replaced with `name` field or [natural keys](https://docs.nautobot.com/projects/core/en/next/development/apps/migration/model-updates/global/#replace-the-usage-of-slugs-with-composite-keys).
 
 ## v1.4.1 (2023-06-07)
 
 ### Fixed
 
-- [#91](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/91) Fixed Hashicorp Vault Authentication with AWS Credentials when region is not set.
+- [#91](https://github.com/nautobot/nautobot-app-secrets-providers/issues/91) Fixed Hashicorp Vault Authentication with AWS Credentials when region is not set.
 
 ## v1.4.0 (2023-04-19)
 
 ### Added
 
-- [#48](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/48) Add token as secret type choice for Delinea/Thycotic
-- [#51](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/51) Add support for AWS Systems Manager Parameter Store
-- [#53](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/53) Add support for Hashicorp Key/Value v1 response
-- [#66](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/66) Add support for Vault Enterprise Namespace parameter
+- [#48](https://github.com/nautobot/nautobot-app-secrets-providers/issues/48) Add token as secret type choice for Delinea/Thycotic
+- [#51](https://github.com/nautobot/nautobot-app-secrets-providers/issues/51) Add support for AWS Systems Manager Parameter Store
+- [#53](https://github.com/nautobot/nautobot-app-secrets-providers/pull/53) Add support for Hashicorp Key/Value v1 response
+- [#66](https://github.com/nautobot/nautobot-app-secrets-providers/pull/66) Add support for Vault Enterprise Namespace parameter
 
 ### Changed
 
-- [#45](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/45) Change references of Thycotic to Delinea
-- [#47](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/47) Change version constraint of HVAC module to allow non-major upgrades
-- [#56](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/56) Change minimum supported Nautobot version to `1.4.0`
-- [#63](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/63) Update plugin description when installed in Nautobot
+- [#45](https://github.com/nautobot/nautobot-app-secrets-providers/pull/45) Change references of Thycotic to Delinea
+- [#47](https://github.com/nautobot/nautobot-app-secrets-providers/pull/47) Change version constraint of HVAC module to allow non-major upgrades
+- [#56](https://github.com/nautobot/nautobot-app-secrets-providers/pull/56) Change minimum supported Nautobot version to `1.4.0`
+- [#63](https://github.com/nautobot/nautobot-app-secrets-providers/pull/63) Update app description when installed in Nautobot
 
 ## v1.3.0 (2022-08-29)
 
 ### Added
 
-- [#32](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/32) Add support for skipping certificate validation when connecting to HashiCorp Vault.
-- [#34](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/34) Add support for alternate authentication to HashiCorp Vault via AWS and Kubernetes authentication methods.
-- [#38](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/38) Add support for Python 3.10.
-- [#40](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/40) Add `default_mount_point` config option for HashiCorp Vault.
+- [#32](https://github.com/nautobot/nautobot-app-secrets-providers/issues/32) Add support for skipping certificate validation when connecting to HashiCorp Vault.
+- [#34](https://github.com/nautobot/nautobot-app-secrets-providers/issues/34) Add support for alternate authentication to HashiCorp Vault via AWS and Kubernetes authentication methods.
+- [#38](https://github.com/nautobot/nautobot-app-secrets-providers/pull/38) Add support for Python 3.10.
+- [#40](https://github.com/nautobot/nautobot-app-secrets-providers/issues/40) Add `default_mount_point` config option for HashiCorp Vault.
 
 ### Changed
 
-- [#42](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/42) Now requires python-tss-sdk version v1.2 or later
+- [#42](https://github.com/nautobot/nautobot-app-secrets-providers/issues/42) Now requires python-tss-sdk version v1.2 or later
 
 ### Fixed
 
-- [#31](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/31) Fixed NameError at startup when installed as `nautobot_secrets_providers[thycotic]`, i.e. without HashiCorp Vault support.
-- [#37](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/37) Various fixes and improvements to the development environment.
+- [#31](https://github.com/nautobot/nautobot-app-secrets-providers/issues/31) Fixed NameError at startup when installed as `nautobot_secrets_providers[thycotic]`, i.e. without HashiCorp Vault support.
+- [#37](https://github.com/nautobot/nautobot-app-secrets-providers/pull/37) Various fixes and improvements to the development environment.
 
 ### Removed
 
-- [#38](https://github.com/nautobot/nautobot-plugin-secrets-providers/pull/38) - Dropped support for end-of-life Python 3.6
+- [#38](https://github.com/nautobot/nautobot-app-secrets-providers/pull/38) - Dropped support for end-of-life Python 3.6
 
 ## v1.2.0 (2022-05-25)
 
 ### Added
 
-- [#8](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/8) Add support for authentication to HashiCorp Vault via AppRole as an alternative to token authentication
-- [#23](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/23) Add support for non-default HashiCorp Vault mountpoints
+- [#8](https://github.com/nautobot/nautobot-app-secrets-providers/issues/8) Add support for authentication to HashiCorp Vault via AppRole as an alternative to token authentication
+- [#23](https://github.com/nautobot/nautobot-app-secrets-providers/issues/23) Add support for non-default HashiCorp Vault mountpoints
 
 ## v1.1.0 (2022-03-10)
 
 ### Added
 
-- [#21](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/21) Add Thycotic Secret Server plugin
+- [#21](https://github.com/nautobot/nautobot-app-secrets-providers/issues/21) Add Thycotic Secret Server plugin
   **Requires Python 3.7 or greater**
 
 ## v1.0.1 (2022-01-06)
 
 ### Fixed
 
-- [#17](https://github.com/nautobot/nautobot-plugin-secrets-providers/issues/17) Fixed `ModuleNotFoundError` when not installing AWS dependencies
+- [#17](https://github.com/nautobot/nautobot-app-secrets-providers/issues/17) Fixed `ModuleNotFoundError` when not installing AWS dependencies
 
 ## v1.0.0 (2021-12-22)
 

GETTING_STARTED.md

@@ -15,7 +15,7 @@
 	- [To Rebuild or Not to Rebuild](#to-rebuild-or-not-to-rebuild)
 		- [Updating Environment Variables](#updating-environment-variables)
 		- [Installing Additional Python Packages](#installing-additional-python-packages)
-		- [Installing Additional Nautobot Plugins](#installing-additional-nautobot-plugins)
+		- [Installing Additional Nautobot Apps](#installing-additional-nautobot-apps)
 		- [Updating Python Version](#updating-python-version)
 		- [Updating Nautobot Version](#updating-nautobot-version)
 	- [Local Development Environment](#local-development-environment)
@@ -169,11 +169,11 @@ This will safely shut down all of your running Docker containers for this projec
 
 Your environment should now be fully setup, all necessary Docker containers are created and running, and you're logged into Nautobot in your web browser. Now what?
 
-Now you can start developing your plugin in the folder generated for you by Cookiecutter.
+Now you can start developing your app in the folder generated for you by Cookiecutter.
 
 ## Docker Magic
 
-The magic here is the root directory is mounted inside your Docker containers when built and ran, so **any** changes made to the files in here are directly updated to the Nautobot plugin code running in Docker. This means that as you modify the code in your `nautobot-plugin` folder (or whatever you named your plugin when generating it via Cookiecutter), the changes will be instantly updated in Nautobot.
+The magic here is the root directory is mounted inside your Docker containers when built and ran, so **any** changes made to the files in here are directly updated to the Nautobot app code running in Docker. This means that as you modify the code in your `nautobot-app` folder (or whatever you named your app when generating it via Cookiecutter), the changes will be instantly updated in Nautobot.
 
 > NOTE: There are a few exceptions to this, as outlined in the section [To Rebuild or Not To Rebuild](#to-rebuild-or-not-to-rebuild).
 
@@ -191,7 +191,7 @@ When trying to debug an issue, one helpful thing you can look at are the logs wi
 
 > NOTE: The `-f` tag will keep the logs open, and output them in realtime as they are generated.
 
-So for example, our plugin is named `secrets`, the command would most likely be `docker logs nautobot_secrets_providers_nautobot_1 -f`. You can find the name of all running containers via `docker ps`.
+So for example, our app is named `secrets`, the command would most likely be `docker logs nautobot_secrets_providers_nautobot_1 -f`. You can find the name of all running containers via `docker ps`.
 
 If you want to view the logs specific to the worker container, simply use the name of that container instead.
 
@@ -217,7 +217,7 @@ Once completed, the new/updated environment variables should now be live.
 
 ### Installing Additional Python Packages
 
-If you want your plugin to leverage another available Nautobot plugin or another Python package, you can easily add them into your Docker environment.
+If you want your app to leverage another available Nautobot app or another Python package, you can easily add them into your Docker environment.
 
 ```bash
 ➜ poetry shell
@@ -232,26 +232,26 @@ Once the dependencies are resolved, stop the existing containers, rebuild the Do
 ➜ invoke start
 ```
 
-### Installing Additional Nautobot Plugins
+### Installing Additional Nautobot Apps
 
-Let's say for example you want the new plugin you're creating to integrate into Slack. To do this, you will want to integrate into the existing Nautobot ChatOps Plugin.
+Let's say for example you want the new app you're creating to integrate into Slack. To do this, you will want to integrate into the existing Nautobot ChatOps app.
 
 ```bash
 ➜ poetry shell
-➜ poetry add nautobot-chatops-plugin
+➜ poetry add nautobot-chatops-app
 ```
 
-Once you activate the virtual environment via Poetry, you then tell Poetry to install the new plugin.
+Once you activate the virtual environment via Poetry, you then tell Poetry to install the new app.
 
-Before you continue, you'll need to update the file `development/nautobot_config.py` accordingly with the name of the new plugin under `PLUGINS` and any relevant settings as necessary for the plugin under `PLUGINS_CONFIG`. Since you're modifying the underlying OS (not just Django files), you need to rebuild the image. This is a similar process to updating environment variables, which was explained earlier.
+Before you continue, you'll need to update the file `development/nautobot_config.py` accordingly with the name of the new app under `PLUGINS` and any relevant settings as necessary for the app under `PLUGINS_CONFIG`. Since you're modifying the underlying OS (not just Django files), you need to rebuild the image. This is a similar process to updating environment variables, which was explained earlier.
 
 ```bash
 ➜ invoke stop
 ➜ invoke build
 ➜ invoke start
 ```
 
-Once the containers are up and running, you should now see the new plugin installed in your Nautobot instance.
+Once the containers are up and running, you should now see the new app installed in your Nautobot instance.
 
 You can even launch an `ngrok` service locally on your laptop, pointing to port 8080 (such as for chatops development), and it will point traffic directly to your Docker images.  How cool!