New Lesson - Junos Automation with PyEZ #117

jnpr-raylam · 2018-10-29T17:40:39Z

stage1: Introduction

What can Automation do?
XML/Netconf
What is PyEZ

stage2: Collect and Parse Information from Junos Devices

Connect to Junos device
Collect data
Parse information

stage3: Configuration Management

Get Junos configuration
Parse Junos configuration
Provision Junos configuration

stage4: PyEZ Tables and Views

PyEZ OpTable
PyEZ ConfigTable

Mierdin · 2018-10-31T08:00:09Z

Is this ready for review?

jnpr-raylam · 2018-10-31T08:03:56Z

Yes, it's ready for review. Apologize for not mention that. Thanks!

Mierdin · 2018-10-31T08:06:26Z

No worries. FFR, there are labels you can use for WIP or RFR as shorthand

…

On Wed, Oct 31, 2018, 1:05 AM Raymond Lam ***@***.*** wrote: Yes, it's ready for review. Apologize for not mention that. Thanks! — You are receiving this because you commented. Reply to this email directly, view it on GitHub <https://github.com/nre-learning/antidote/pull/117#issuecomment-434595267>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AECM-_edrucDCmV2ElXzLDkLt1SabnoRks5uqVltgaJpZM4X_t0j> .

Mierdin

@jnpr-raylam This is an EPIC lesson. Thanks so much for working on this, it's clear you spent a lot of time on it.

My biggest concern is that this is a TON of content, which is a good problem to have, but we need to make sure we keep a few things in mind to preserve the spirit of the site:

Don't gloss over explanations in favor of interactive examples. It's good to have the code snippets (and boy do you have a lot of them) but we need to make sure the user is mentally along for the ride, not just clicking the buttons
The examples should flow a little better. In many cases, it's not clear if you intended something to work or not work - if you are having them run a command but it's not meant to work, highlighting this with a comment is useful. There are several places where you have a set of snippets for them to run, with no paragraphs in between. It's those breaks between examples where we get an opportunity to keep them hooked with explanations, so let's make sure to do that.
I also noticed in a few places you started a section with a huge code snippet they don't have to run, then you repeat parts of that snippet as interactive examples. Rather than the large snippet up front, take a moment to explain what they're about to do in plain-english. Then they'll want to understand the smaller snippets more readily.
This is a lot of content (again, good problem) and it can get tough to get through it all. Some ideas: maybe break up into even more stages (i.e. stage 2 is huge)? Also, adding images can help break up the monotony

Thanks again for this great lesson; I am excited to get this merged soon!

Mierdin · 2018-10-31T22:36:07Z

lessons/lesson-24/syringe.yaml

+---
+lessonName: Junos Automation with PyEZ
+lessonID: 24
+category: introductory


I would definitely put this in the configuration category

Mierdin · 2018-10-31T23:03:11Z

lessons/lesson-24/stage1/guide.md

+For HTTP, telnet to web server port 80
+
+```
+telnet labs.networkreliability.engineering 80


Not sure how well documented this is (will go make sure of this now) but no internet access is permitted outside the cluster - and this includes even the external IP address this will resolve to. My suggestion is to either:

Spin up your own webserver

Skip this example and move right into SSH/NETCONF.

My preference would be the latter, since the REST APIs lesson does some basic curl examples, and this isn't as closely related to this lesson's content (netconf)

Mierdin · 2018-10-31T23:03:49Z

lessons/lesson-24/stage1/guide.md

+
+To get the web page, issue the GET command, following the relative path of the web page, and then specify the HTTP version, and at last provide the 'Host' field to specify the web host.
+
+<pre>


Again I would prefer skipping this example but if you keep it in, please use the three-backticks model consistently for snippets.

Mierdin · 2018-10-31T23:05:28Z

lessons/lesson-24/stage1/guide.md

+```
+<button type="button" class="btn btn-primary btn-sm" onclick="runSnippetInTab('linux1', 3)">Run this snippet</button>
+
+#### 3. What is PyEZ


This section reads a bit rough. Note that folks will be likely going through this step by step, and in this section, they'll be overwhelmed with a bunch of list items. Paragraphs with illustrative examples will win here.

Mierdin · 2018-10-31T23:07:17Z

lessons/lesson-24/stage1/guide.md

+  - perform regular expression matching on the response
+  - extract the information
+  - a litter bit easier compared to pure Python code
+  - <a href="https://raw.githubusercontent.com/jnpr-raylam/antidote/lesson-24/lessons/lesson-24/stage1/sample_code/get-uptime-ncclient.py" target="_blank">Sample code here: get-uptime-ncclient.py</a>


In these links, please use the main nre-learning/antidote repo

Mierdin · 2018-10-31T23:12:05Z

lessons/lesson-24/stage2/guide.md

+
+```
+print(dev.display_xml_rpc('show interfaces em3', format='text'))
+intf = dev.rpc.get_interface_information(interface_name='em3')


Nothing is done with many of these intf variables.

Mierdin · 2018-10-31T23:15:54Z

lessons/lesson-24/stage1/guide.md

@@ -0,0 +1,123 @@
+## Junos Automation with PyEZ
+


Please give yourself credit near the top of each guide. Something like **Contributed by @jnpr-raylam**

Mierdin · 2018-10-31T23:17:57Z

lessons/lesson-24/stage2/guide.md

+Unsupported `OR` operator:
+
+```
+xml.findall('ifd[mtu="1514" or ifl]')


On this and the next two examples, I got SyntaxError: Invalid predicate

Mierdin · 2018-10-31T23:22:33Z

lessons/lesson-24/stage2/guide.md

+<pre>
+for ifd in intf.xpath('physical-interface'):
+    name = ifd.xpath('name')[0].text
+    mac = ifd.xpath('hardware-physical-address')[0].text


I'd recommend adding a comment or some other notice that makes it clear that this should fail

Mierdin · 2018-10-31T23:25:27Z

lessons/lesson-24/stage3/guide.md

+
+For this syntax, call the `load()` and `commit()` function of `cu` variable to load and commit config on Junos device
+
+```


Starting here, the rest of the examples in this section don't have "run this snippet" buttons. Is this intentional?

Mierdin · 2018-10-31T23:41:04Z

lessons/lesson-24/stage4/guide.md

+### Junos Automation with PyEZ
+
+#### Part 4 - PyEZ Tables and Views
+


A brief introduction to what these are, as well as why someone should care about them, would be a good idea.

jnpr-raylam · 2018-11-01T17:45:46Z

@Mierdin, Thanks for your comment, I have updated the lesson accordingly, could you please review again.

FYI, in some code snippets, I intentionally use <pre> instead of three-backticks. Because those code snippet requires the last ENTER key to execute Python interactive for loop, if using three-backticks, the markdown will strip out the last newline, so user has to press ENTER manually in the terminal.
Use <pre> explicitly to make sure it will send out the last ENTER.

Mierdin · 2018-11-06T00:23:08Z

I'm still of the opinion that a few of the sections are extremely long, bordering on too exhaustive. It's great detail, but the spirit of the content shouldn't be as a reference - we have docs for that. We need to focus on illustrative examples, where we get the maximum bang for our buck. You've made great strides towards this in this PR but I think there's more that can be done here.

Could you consider breaking up stage 3? It's still clocking in at 557 lines right now. Also, across the entire lesson, consider areas where you could be a little more terse. Some of the examples are definitely more compelling than others, and they tend to get drowned in the noise a little bit. Remember that the goal is for someone to be able to get through a lesson stage in under 5 minutes.

Hopefully that's not too generic, and also hopefully you're not getting the sense that I'm asking you to throw out huge chunks of what you've worked on - I'm not. I just want to make sure that what content is there has the maximum impact on an audience, that likely hasn't seen any pyez or python before.

jnpr-raylam · 2018-11-06T05:44:12Z

@Mierdin, Thanks for your comment, I have trimmed down the lesson content to make to more clear and suitable for beginners. Hope that matches the NRE lessons' spirit.
Would you please review again? Thanks.

Mierdin · 2018-11-06T06:49:45Z

@jnpr-raylam Thanks - at first glance it's looking a lot better. Will look in more detail shortly, but in the meantime, why remove the tables and views lab? It's a useful component of pyez and think it should be included - my main concern was the length and verbosity on some of the middle stages - the tables and views one was solid as-is, mostly. Esp considering it's on a separate stage, I'd love to see it re-included unless you feel strongly otherwise.

…nto lesson-24

jnpr-raylam · 2018-11-06T07:51:54Z

@Mierdin, Originally I thought the content is too much, but thanks for your recommendation, I added back the PyEZ Tables section and trimmed down to remove advanced Tables topic.
Would you please review? Thanks!

Mierdin · 2018-11-06T08:20:44Z

Thanks. Yeah the number of stages is fine. I'd rather have more stages that are short enough to get through quickly than fewer stages that might take more time than 5-7 minutes

Mierdin

LGTM - thanks again!

Add Junos Automation with PyEZ lesson

5adca66

Mierdin added the RFR I'm ready for someone to review this. label Oct 31, 2018

Mierdin changed the title ~~WIP: Add Junos Automation with PyEZ - 24~~ Add Junos Automation with PyEZ - 24 Oct 31, 2018

Mierdin suggested changes Oct 31, 2018

View reviewed changes

Mierdin reviewed Oct 31, 2018

View reviewed changes

Update for Mierdin's comment

56b08a5

Mierdin changed the title ~~Add Junos Automation with PyEZ - 24~~ New Lesson - Junos Automation with PyEZ Nov 6, 2018

Update the lessons to make it short and clear

530820b

Mierdin and others added 3 commits November 5, 2018 22:53

Merge branch 'master' into lesson-24

671b6aa

Add back PyEZ Table lesson

afe544b

Merge branch 'lesson-24' of https://github.com/jnpr-raylam/antidote i…

14eee5e

…nto lesson-24

Mierdin approved these changes Nov 9, 2018

View reviewed changes

Mierdin merged commit b1da910 into nre-learning:master Nov 9, 2018

Mierdin mentioned this pull request Nov 13, 2018

Junos Automation with PyEZ #113

Closed

jnpr-raylam deleted the lesson-24 branch February 5, 2019 18:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Lesson - Junos Automation with PyEZ #117

New Lesson - Junos Automation with PyEZ #117

jnpr-raylam commented Oct 29, 2018

Mierdin commented Oct 31, 2018

jnpr-raylam commented Oct 31, 2018

Mierdin commented Oct 31, 2018 via email

Mierdin left a comment •

edited

Loading

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

Mierdin Oct 31, 2018

jnpr-raylam commented Nov 1, 2018

Mierdin commented Nov 6, 2018

jnpr-raylam commented Nov 6, 2018

Mierdin commented Nov 6, 2018

jnpr-raylam commented Nov 6, 2018

Mierdin commented Nov 6, 2018

Mierdin left a comment


		To get the web page, issue the GET command, following the relative path of the web page, and then specify the HTTP version, and at last provide the 'Host' field to specify the web host.

		<pre>


		For this syntax, call the `load()` and `commit()` function of `cu` variable to load and commit config on Junos device

		```

		### Junos Automation with PyEZ

		#### Part 4 - PyEZ Tables and Views

New Lesson - Junos Automation with PyEZ #117

New Lesson - Junos Automation with PyEZ #117

Conversation

jnpr-raylam commented Oct 29, 2018

Mierdin commented Oct 31, 2018

jnpr-raylam commented Oct 31, 2018

Mierdin commented Oct 31, 2018 via email

Mierdin left a comment • edited Loading

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

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

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

jnpr-raylam commented Nov 1, 2018

Mierdin commented Nov 6, 2018

jnpr-raylam commented Nov 6, 2018

Mierdin commented Nov 6, 2018

jnpr-raylam commented Nov 6, 2018

Mierdin commented Nov 6, 2018

Mierdin left a comment

Choose a reason for hiding this comment

Mierdin left a comment •

edited

Loading