Various updates, will squash with more meaningful message later #577

itdependsnetworks · 2023-09-10T16:32:22Z

No description provided.

mzbroch · 2023-09-11T14:05:47Z

Now that we have PLAN/DEPLOY settings , can we auto-enable related jobs from plugin init as suggested in nautobot/nautobot#4398 (comment) (only if already enabled through settings) ?

joewesch · 2023-09-11T14:53:17Z

These warnings are showing up on all Config Plan views. Should these warnings be isolated to the view they are actually used?

Generate Config Plans > Config Plan Create
Deploy Config Plans > Config Plan List
Deploy Config Plan (Job Button Receiver) >  Config Plan Detail View

nautobot_golden_config/forms.py

docs/admin/admin_install.md

docs/user/app_getting_started.md

nautobot_golden_config/forms.py

nautobot_golden_config/jobs.py

itdependsnetworks · 2023-09-11T15:11:45Z

These warnings are showing up on all Config Plan views. Should these warnings be isolated to the view they are actually used?

I personally found it confusing it was scoped to just the create. Fail early, fail often... what do you guys think?

joewesch · 2023-09-11T15:21:55Z

If you disable generate then there will be nothing to deploy. Having the ability to enable deploy without generate would not work and cause confusion. Maybe combine them into one setting or throw a warning when they disable generate but not deploy?

mzbroch · 2023-09-11T16:15:53Z

If you disable generate then there will be nothing to deploy. Having the ability to enable deploy without generate would not work and cause confusion. Maybe combine them into one setting or throw a warning when they disable generate but not deploy?

Following use cases are valid :

As a user , I want to generate a plan in Nautobot and deploy it with a different tool - manually, Ansible/AWX, etc.
As a user , I want to post a custom Config PLAN through the API (type manual) , and perform change approval to later either deploy with Ansible/AWX/manually/Nautobot.

mzbroch · 2023-09-11T16:19:22Z

These warnings are showing up on all Config Plan views. Should these warnings be isolated to the view they are actually used?
Generate Config Plans > Config Plan Create
Deploy Config Plans > Config Plan List
Deploy Config Plan (Job Button Receiver) >  Config Plan Detail View

I will stay in a position , where Job should be automatically enabled by the plugin's ORM if settings are set to "ENABLE". This will improve user experience and decrease complexity

joewesch · 2023-09-11T16:51:38Z

As a user , I want to generate a plan in Nautobot and deploy it with a different tool - manually, Ansible/AWX, etc.

This is if generate is enabled and deploy is disabled. I did not speak on this use case and it is still valid.

As a user , I want to post a custom Config PLAN through the API (type manual) , and perform change approval to later either deploy with Ansible/AWX/manually/Nautobot.

The POST method is intentionally disabled for the API view on config plans as they should be generated via Job:
https://github.com/nautobot/nautobot-plugin-golden-config/blob/6d8326762cf4be1d152346293edbfebe84c13d18/nautobot_golden_config/api/views.py#L134-L135

jeffkala · 2023-09-12T04:43:32Z

These warnings are showing up on all Config Plan views. Should these warnings be isolated to the view they are actually used?

I personally found it confusing it was scoped to just the create. Fail early, fail often... what do you guys think?

Only thing to me that is now confusing with these warnings, is that we don't warn for an identical scenario for the other "featuers" that GC has. We don't warn that backup jobs, intended, etc. are not enabled. I know the scope is slightly different because some of these are hidden. But just curious what others think on this note.

…nal, set status instead

nautobot_golden_config/forms.py

Co-authored-by: Jeff Kala <[email protected]>

joewesch · 2023-09-12T13:26:30Z

nautobot_golden_config/jobs.py


    def receive_job_button(self, obj):
        """Run config plan deployment process."""
        self.log_debug("Starting config plan deployment job.")
        data = {"debug": False, "config_plan": ConfigPlan.objects.filter(id=obj.id)}
        config_deployment(self, data, commit=True)
        if not self.failed:
-            obj.delete()
+            obj.update(status=Status.objects.get(slug="completed"))


We need to update the config_deployment nornir play to now fail if any of the plans are Completed. We don't want to deploy the same config plan twice.

I think You could gracefully skip implemented tasks. In the longer-run , we could discuss how to present archive config plans (maybe second List View ?)

In this implementation , you can have three stages :

start (status planned)

inprogress (status in-implementation)

finish (status implemented / errored)

Ideally, You can only start tasks in a certain status : planned or failed.
Tasks in progress (during implementation) should also change status to in-progress for the duration of the actual job
Tasks finalised: either deployed (implemented), either "errored"

STATE_MACHINE = { "start": { "provision": ["Planned", "Failed", "Decommissioned"], "deprovision": ["Active", "Failed"], }, "inprogress": { "provision": "Provisioning", "deprovision": "Deprovisioning", }, "finish": { "provision": "Active", "deprovision": "Decommissioned", }, }

nautobot_golden_config/migrations/0025_auto_20230912_0352.py

* revert to develop migrations files and create new one for changes

Co-authored-by: Ken Celenza <[email protected]>

mzbroch · 2023-09-13T12:52:41Z

nautobot_golden_config/models.py

    "graphql",
+    "relationships",
+    "webhooks",


The reason we had only graphql was the GoldenConfigSetting model :

@extras_features( "graphql", ) class GoldenConfigSetting(PrimaryModel): # pylint: disable=too-many-ancestors

ok, I think that was an oversight as well. Will fix in 2.0

nautobot_golden_config/nornir_plays/config_deployment.py

nautobot_golden_config/filters.py

* Adds URL validation to Config Plan creation form * Update nautobot_golden_config/templates/nautobot_golden_config/configplan_create.html --------- Co-authored-by: Jeff Kala <[email protected]>

…nternet to pull form nautobot core static which fixes #585 (#587) * fix dynamic status changes during deployment * fixes filters on empty results from erroring * few additional cleanups * run black * remove unused import * change jquery from internet to pull form nautobot core static, fixes #585

…d documentation(#589) * some flake8 fixes * fix broken flake8 and pylint configs and actual issues, and update run_job.js * add ADRs * add documetnation

mzbroch · 2023-09-14T14:30:01Z

Issue within template :

mzbroch · 2023-09-14T14:35:57Z

In the Config Plan List view, there is a "Job Result" column. In most cases, users will be interested in seeing the deployment result, and what is presented to them is the result from the job creating the config plan

…lden-config into wg-kc-update

mzbroch · 2023-09-14T15:48:45Z

nautobot_golden_config/models.py

-        null=False,
-        blank=False,


I am still not sure about this change.

We decided to generate config plans with job-helper, however we ended-up:

disabling CSV imports of config plans

disabling API creation of config plans

Nothing has functionally changed

I was saying , that the ConfigPlan model makes the jobID mandatory - you cannot have ConfigPlan without having a Job first.
The only one point I am making today is that we can possibly have more ways of populating this in the future - CSVs , APIs etc.

mzbroch

LGTM

mzbroch · 2023-09-14T15:51:30Z

nautobot_golden_config/views.py

+                Job.objects.get(module_name="nautobot_golden_config.jobs", job_class_name="GenerateConfigPlans"),
+                request,


is it possible to use string-ified imported elements here?

I am not sure about the request or the benefits, do you mind explaining further?

I was thinking we could avoid re-typing class names, possibly making it harder to make mistake in the future.

Co-authored-by: Jeff Kala <[email protected]>

jeffkala · 2023-09-15T05:48:17Z

In the Config Plan List view, there is a "Job Result" column. In most cases, users will be interested in seeing the **deployment** result, and what is presented to them is the result from the job creating the config plan

played with this for awhile, but ultamietly its just all "completed" since if a ConfigPlan job creation fails the configplan itself isn't ever created.

Example of what it looks like, but not sure it would ever be anything other than completed.

mzbroch · 2023-09-15T06:18:21Z

played with this for awhile, but ultamietly its just all "completed" since if a ConfigPlan job creation fails the configplan itself isn't ever created.

Example of what it looks like, but not sure it would ever be anything other than completed.

This is exactly my point -

impression is , that actual "deployment" is completed. (once the configPlan has been created, the "Job Result" of creating the object is not the most important)

…lden-config into wg-kc-update

jeffkala · 2023-09-15T16:20:51Z

played with this for awhile, but ultamietly its just all "completed" since if a ConfigPlan job creation fails the configplan itself isn't ever created.
Example of what it looks like, but not sure it would ever be anything other than completed.

This is exactly my point -

impression is , that actual "deployment" is completed. (once the configPlan has been created, the "Job Result" of creating the object is not the most important)

Have a fix for this i'm finalizing.

* implement plan_result and deploy_result * change cascade to protect * Update nautobot_golden_config/nornir_plays/config_deployment.py Co-authored-by: Joe Wesch <[email protected]> * fix filter and typo --------- Co-authored-by: Joe Wesch <[email protected]>

Various updates, will squash with more meaningful message later

f09c633

itdependsnetworks requested review from jeffkala and nkallergis as code owners September 10, 2023 16:32

joewesch reviewed Sep 11, 2023

View reviewed changes

nautobot_golden_config/forms.py Outdated Show resolved Hide resolved

jeffkala requested changes Sep 11, 2023

View reviewed changes

docs/admin/admin_install.md Outdated Show resolved Hide resolved

docs/admin/admin_install.md Outdated Show resolved Hide resolved

docs/user/app_getting_started.md Outdated Show resolved Hide resolved

nautobot_golden_config/forms.py Outdated Show resolved Hide resolved

joewesch reviewed Sep 11, 2023

View reviewed changes

nautobot_golden_config/jobs.py Show resolved Hide resolved

itdependsnetworks added 2 commits September 12, 2023 00:54

Correct required implementation, squash migrations, remove delete sig…

141ef8d

…nal, set status instead

revert one

5af7bdf

itdependsnetworks commented Sep 12, 2023

View reviewed changes

nautobot_golden_config/forms.py Show resolved Hide resolved

itdependsnetworks and others added 3 commits September 12, 2023 08:09

Apply suggestions from code review

3a99a0a

Co-authored-by: Jeff Kala <[email protected]>

minor clean up

b242406

remove bracket

a74f7b0

joewesch reviewed Sep 12, 2023

View reviewed changes

itdependsnetworks and others added 7 commits September 12, 2023 17:37

updates

262777f

revert to develop migrations files and create new one for changes (#580)

7cf6ec4

* revert to develop migrations files and create new one for changes

forms and signals

0366578

Add status back

d587715

Lint

1a7e197

more updates

71dc3e5

first round of fixes (#581)

f64009d

Co-authored-by: Ken Celenza <[email protected]>

mzbroch reviewed Sep 13, 2023

View reviewed changes

Add complete jobs filter

b8889ec

joewesch reviewed Sep 13, 2023

View reviewed changes

nautobot_golden_config/nornir_plays/config_deployment.py Outdated Show resolved Hide resolved

joewesch reviewed Sep 13, 2023

View reviewed changes

nautobot_golden_config/filters.py Outdated Show resolved Hide resolved

nautobot_golden_config/filters.py Outdated Show resolved Hide resolved

joewesch and others added 3 commits September 13, 2023 21:06

Adds URL validation to Config Plan creation form (#588)

d29faf4

* Adds URL validation to Config Plan creation form * Update nautobot_golden_config/templates/nautobot_golden_config/configplan_create.html --------- Co-authored-by: Jeff Kala <[email protected]>

fix flake8, pylint configs and issues, and update run_job.js , and ad…

cc92274

…d documentation(#589) * some flake8 fixes * fix broken flake8 and pylint configs and actual issues, and update run_job.js * add ADRs * add documetnation

update nornir nautobot and plugin pinning

55cd34e

mzbroch and others added 3 commits September 14, 2023 10:42

changing confirm message (#591)

952345d

fix incorrectly changed nautobot pin

66a2c88

Merge branch 'wg-kc-update' of github.com:nautobot/nautobot-plugin-go…

89b2af7

…lden-config into wg-kc-update

mzbroch reviewed Sep 14, 2023

View reviewed changes

mzbroch approved these changes Sep 14, 2023

View reviewed changes

jeffkala and others added 3 commits September 14, 2023 10:03

updates html to show count of configplans created

5ee9bff

change view button to more advanced filter and button name

46f76a8

changing app getting started doc (#592)

74859f7

Co-authored-by: Jeff Kala <[email protected]>

jeffkala added 2 commits September 15, 2023 00:45

fix config plan detail view scroll issue

39488db

Merge branch 'wg-kc-update' of github.com:nautobot/nautobot-plugin-go…

f88b8c3

…lden-config into wg-kc-update

joewesch and others added 3 commits September 15, 2023 11:04

Changes job to fail if any plans are completed (#593)

b16d824

remove commented out code

60f35e9

jeffkala approved these changes Sep 15, 2023

View reviewed changes

itdependsnetworks merged commit 838a01c into develop Sep 15, 2023

itdependsnetworks deleted the wg-kc-update branch October 2, 2023 03:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Various updates, will squash with more meaningful message later #577

Various updates, will squash with more meaningful message later #577

itdependsnetworks commented Sep 10, 2023

mzbroch commented Sep 11, 2023 •

edited

Loading

joewesch commented Sep 11, 2023 •

edited

Loading

itdependsnetworks commented Sep 11, 2023

joewesch commented Sep 11, 2023 •

edited

Loading

mzbroch commented Sep 11, 2023 •

edited

Loading

mzbroch commented Sep 11, 2023

joewesch commented Sep 11, 2023

jeffkala commented Sep 12, 2023

joewesch Sep 12, 2023

mzbroch Sep 12, 2023 •

edited

Loading

mzbroch Sep 13, 2023 •

edited

Loading

itdependsnetworks Sep 13, 2023

mzbroch commented Sep 14, 2023

mzbroch commented Sep 14, 2023

mzbroch Sep 14, 2023

itdependsnetworks Sep 15, 2023

mzbroch Sep 15, 2023

mzbroch left a comment

mzbroch Sep 14, 2023

itdependsnetworks Sep 14, 2023

mzbroch Sep 15, 2023

jeffkala commented Sep 15, 2023

mzbroch commented Sep 15, 2023

jeffkala commented Sep 15, 2023

		Job.objects.get(module_name="nautobot_golden_config.jobs", job_class_name="GenerateConfigPlans"),
		request,

Various updates, will squash with more meaningful message later #577

Various updates, will squash with more meaningful message later #577

Conversation

itdependsnetworks commented Sep 10, 2023

mzbroch commented Sep 11, 2023 • edited Loading

joewesch commented Sep 11, 2023 • edited Loading

itdependsnetworks commented Sep 11, 2023

joewesch commented Sep 11, 2023 • edited Loading

mzbroch commented Sep 11, 2023 • edited Loading

mzbroch commented Sep 11, 2023

joewesch commented Sep 11, 2023

jeffkala commented Sep 12, 2023

Choose a reason for hiding this comment

mzbroch Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

mzbroch Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mzbroch commented Sep 14, 2023

mzbroch commented Sep 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mzbroch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffkala commented Sep 15, 2023

mzbroch commented Sep 15, 2023

jeffkala commented Sep 15, 2023

mzbroch commented Sep 11, 2023 •

edited

Loading

joewesch commented Sep 11, 2023 •

edited

Loading

joewesch commented Sep 11, 2023 •

edited

Loading

mzbroch commented Sep 11, 2023 •

edited

Loading

mzbroch Sep 12, 2023 •

edited

Loading

mzbroch Sep 13, 2023 •

edited

Loading