Skip to content

Commit 50345bb

Browse files
author
skkumaravel
authored
Updated READ.me
1 parent c8f0491 commit 50345bb

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ Author: Karthik Kumaravel
44

55
Contact: kkumara3@cisco.com
66

7-
This is a small repo testing GRPC in python for the IOS-XR end node. This setup is currently working in the IOS-XRv on vagrant.
8-
9-
To get started with IOS-XRv on Vagrant: https://xrdocs.github.io/
10-
11-
The example is a small python file showing how to set up the connection and use one of the rpc calls. Please look at the unit-testing and client page for more rpc calls.
7+
This is a small repo showing how to use GRPC in python for the IOS-XR end node.The repo is consisted of three main componenets, the compiled pb2 file from the IDL, a python client accessing the pb2 file, and an example python file. The example is a small python file showing how to set up the connection and use one of the rpc calls. Please look at the unit-testing and client page for more rpc calls. At the bottom of the repo, there is a walkthrough of how to create your own client.
128

139
If you find any problems with this repo, please file a bug so I can fix it. If you need help, feel free to contact me.
1410

@@ -53,6 +49,20 @@ scp cisco@192.168.1.2:/misc/config/grpc/ems.pem ./
5349
python grpc_example.py
5450
```
5551

52+
Getting here from the beginning
53+
--
54+
To create a client of your own there are a few steps to follow.
55+
56+
- Download the proto file for IOS-XR's grpc: https://github.com/CiscoDevNet/grpc-getting-started
57+
- Follow the instructions to generate the client/server code in python using the grpc-getting-started's proto file: http://www.grpc.io/docs/tutorials/basic/python.html#generating-client-and-server-code
58+
- From here create a client, an example can be found here: http://www.grpc.io/docs/tutorials/basic/python.html#creating-the-client
59+
- At this point you should have a client similar to the one in this repo
60+
61+
Other Useful Links
62+
--
63+
If you would like to test this all out with IOS-XRv, use the following link to request access to the vagrant box.
64+
65+
https://xrdocs.github.io/
5666

5767
To be done
5868
--

0 commit comments

Comments
 (0)