|
1 | | -# DEVASC Model-Driven Programmability |
| 1 | +# Cisco DevNet Associate NETCONF Introduction Hands-On Lab Guide |
2 | 2 |
|
3 | | -## Introduction to NETCONF |
| 3 | + |
4 | 4 |
|
5 | 5 | ## Overview |
6 | 6 |
|
7 | | -This repo will guide you through hands-on Model-Driven Programmability (MDP) NETCONF exercises with Cisco CSR1000v devices. The excercsies support the learning objectives in sections 3.8, 5.1, 5.10, and 5.11 in the [Cisco DEVASC exam topics](https://learningnetwork.cisco.com/s/devnet-associate-exam-topics). |
| 7 | +What's the big fuss over IT automation? Well, more than anything, the excitement is about the sorts of things that you _don't_ have to do when automation is on your side. Things like _not_ having to either copy and paste configuration changes to dozens (maybe hundreds) of different systems or repeat the same click, click, click, click, click-through-the-UI marathon over, and over, and over..._every single time_ there's a need to make a bulk change :rage:. |
8 | 8 |
|
9 | | -The **Lab Setup** section of this document has step-by-step directions to help you access the learning materials using [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html) within the WWT [Programmability Foundations Lab](https://www.wwt.com/lab/programmability-foundations-lab). |
| 9 | +To automate configuration and management workflows for network devices, we need to learn to write some form of automation-specific code, and the **NETCONF** protocol makes that possible. **NETCONF** provides a programmatic way to automate the network device workflows based on the predictable data structures found in YANG models. |
10 | 10 |
|
11 | | ---- |
12 | | - |
13 | | -## Lab Setup |
14 | | - |
15 | | -The lab setup process is almost entirely automated and leverages the **Cisco CSR 1000v devices** in the WWT [Programmability Foundations Lab](https://www.wwt.com/lab/programmability-foundations-lab). |
16 | | - |
17 | | -:clock1: **Plan for the automated lab setup to take 5-10 minutes**. Follow these steps to setup the lab environment: |
18 | | - |
19 | | -1. Launch a new copy of the [Programmability Foundations Lab](https://www.wwt.com/lab/programmability-foundations-lab) and click [View Labs](https://www.wwt.com/my-wwt/labs): |
20 | | - |
21 | | - |
22 | | - |
23 | | -2. From the [My Labs](https://www.wwt.com/my-wwt/labs) page, click **Access Lab**: |
24 | | - |
25 | | - |
26 | | - |
27 | | -3. Click the **Open in ATC Lab Gateway** button: |
28 | | - |
29 | | - |
30 | | - |
31 | | -4. Click the System Tray icon and mouse over the **Docker icon** to reveal the status. |
32 | | - - :clock1: The icon may take a minute or so to appear. |
33 | | - |
34 | | - |
| 11 | +This guide will walk you through some hands-on exercises that help teach and give you a place to practice using Python to automate workflows with **NETCONF**. You'll get the most from these exercises if you have some familiarity with: |
35 | 12 |
|
36 | | -5. The Docker service is ready when a small exclamation point appears over the **Docker icon**. |
37 | | - - :clock1: It may be a few minutes before the Docker service is ready |
38 | | - |
39 | | - |
40 | | - |
41 | | ---- |
42 | | - |
43 | | -:heavy_exclamation_mark: Occasionally, the Docker Desktop service does not start on its own. Windows may ask you if you want to start the Docker service and thereafter request permission for **Net Command** to run. You may safely confirm both actions. |
44 | | - |
45 | | - |
46 | | - |
47 | | - |
| 13 | +- :snake: Python fundamentals. |
| 14 | +- :scroll: Managing and transposing structured data between XML and Python objects. |
| 15 | +- :desktop_computer: Interpreting YANG models. |
48 | 16 |
|
49 | 17 | --- |
50 | 18 |
|
51 | | -6. A PowerShell script will customize the lab environment automatically although and you need to paste a long command into a PowerShell window in order to start that process. |
52 | | - - Click the PowerShell icon in the task bar to open a new PowerShell window. Then, copy the entire command below to your clipboard, **right-click** in the PowerShell window to paste the command, and press your *Return/Enter* key to run the command: |
53 | | - |
54 | | -```powershell |
55 | | -Set-Executionpolicy -Scope CurrentUser -ExecutionPolicy UnRestricted -Force; Set-Location \Users\admin; Invoke-WebRequest -Uri 'https://devasc-netconf.s3-us-west-2.amazonaws.com/setup_lab.ps1' -OutFile 'setup_lab.ps1’; .\setup_lab.ps1 |
56 | | -``` |
57 | | - |
58 | | - |
59 | | - |
60 | | - :bangbang: If the PowerShell script exits with a message indicating that the **Docker process is not started**, refer to the **Troubleshooting** section at the bottom of this document . |
61 | | - |
62 | | -7. :clock1: Within a few minutes, when the lab is ready to use, a Chrome browser will open a **JupyterLab** URL. |
63 | | - - Open the folder **devasc-netconf-intro**. |
64 | | - |
65 | | - |
66 | | - |
67 | | -8. Next, open the **lab** folder. |
68 | | - |
69 | | - |
70 | | - |
71 | | -9. Open the **Jupyter Notebook** file named **ncclient.ipynb** |
72 | | - |
73 | | - |
74 | | - |
75 | | -10. The NETCONF lab walkthrough guide will open and JupyterLab deployed correctly. |
76 | | - |
77 | | - |
78 | | - |
79 | | -11. The PowerShell script will continue to run, behind the Chrome browser window, and deploy the **YANG Suite** application. |
80 | | - |
81 | | - - When the YANG Suite deployment completes, a second Chrome browser tab will open. |
82 | | - |
83 | | - :bangbang: You do **not** need to log on to YANG Suite at this time. |
84 | | - |
85 | | - - :white_check_mark: The automated lab setup should be complete and the PowerShell window will display a message to indicate whether or not setup was successful. |
86 | | - |
87 | | - |
88 | | - |
89 | | -12. The setup process creates a two shortcuts on the Windows desktop which will help you restore the lab environment, in the event the Chrome tab closes, Windows restarts, etc. |
90 | | - |
91 | | - - The **Restart Lab** shortcut re-launches JupyterLab (including the Chrome browser tab), which takes a few seconds, and does not restart the entire 5-10 minute lab configuration process. |
92 | | - - The YANG Suite shortcut will reopen the YANG Suite Chrome browser tab. |
93 | | - |
94 | | -:large_orange_diamond: **Double-clicking these links will NOT cause you to lose any of your lab progress** :large_orange_diamond: |
95 | | - |
96 | | - |
97 | | - |
98 | | ---- |
99 | | - |
100 | | -## Docker Troubleshooting |
101 | | - |
102 | | -From time-to-time, Windows takes a lenghty amount of time to successfully start the Docker Desktop process and rarely, Windows will fail to start Docker Desktop. If Windows cannot start Docker Desktop, your first indication will be an error message when you run the PowerShell script which configures the lab. |
103 | | - |
104 | | - |
105 | | - |
106 | | -As the error message indicates, PowerShell will attempt to start or restart the Docker Desktop process. After a few seconds, the Docker Desktop application will open behind the PowerShell and you may bring it to the foreground to monitor the status. |
107 | | - |
108 | | -- A **teal**-colored icon in the lower-left corner of the Docker Desktop application indicates the Docker process is running and you should be able to re-run the PowerShell script to configure the lab environment. Sometimes, Windows takes 5-10 minutes to start the Docker process. |
109 | | -- An **orange**-colored icon in the lower-left corner of the Docker Desktop application indicates the Docker process is **not** running and you have a couple of options: |
110 | | - - Wait up to 10 minutes to see if Windows is able to start the Docker process. |
111 | | - - Launch a new instance of the [Programmability Foundations Lab](https://www.wwt.com/lab/programmability-foundations-lab). |
| 19 | +## Usage |
112 | 20 |
|
113 | | - |
| 21 | +Navigate to [https://wwt.github.io/devasc-netconf-intro](https://wwt.github.io/devasc-netconf-intro) and follow the guided walkthrough instructions. |
0 commit comments