examples: add I&T studio onboarding example

Change-Id: I3d78f546d2fa6d9d9e383cd4061e9675f574cc4a

Author: noredistribution

examples/resources/studio/README.md

@@ -0,0 +1,89 @@
+# Studios examples
+
+These examples use multiple resources including studio.v1, workspace.v1, studio_topology.v1.
+
+## Authenticating with CloudVision
+
+### CloudVision On-Prem
+
+Service accounts are the recommended way to generate tokens (same steps can be used as on [CVaaS](#cloudvision-as-a-service)).
+
+For quick tests the [get_token.py](../../get_token.py) script can be used to get the token and the certificate from
+the CloudVision server:
+
+`python3 get_token.py --server 192.0.2.79 --username cvpadmin --password arastra --ssl`
+
+The two files that will be saved can then be used to authenticate:
+- token.txt
+- cvp.crt
+
+### CloudVision as a Service
+
+To access the CloudVision as-a-Service and send API requests, “Service Account Token” is needed.
+After obtaining the service account token, it can be used for authentication when sending API requests.
+
+Service accounts can be created from the Settings page where a service token can be generated as seen below:
+
+![serviceaccount1](../../Connector/media/serviceaccount1.png)
+![serviceaccount2](../../Connector/media/serviceaccount2.png)
+![serviceaccount3](../../Connector/media/serviceaccount3.png)
+
+## studio_onboarding.py
+
+The `studio_onboarding.py` script can be used to manage the `Inventory & Topology` studio to onboard
+devices and their interfaces.
+
+```shell
+python examples/resources/studio/studio_onboarding.py --help
+usage: studio_onboarding.py [-h] --server SERVER --token-file TOKEN_FILE [--cert-file CERT_FILE] [--wsid WSID]
+                            [--operation {set,get,set-all}] [--update-id UPDATE_ID] [--build-only BUILD_ONLY]
+
+options:
+  -h, --help            show this help message and exit
+  --server SERVER       CloudVision server to connect to in <host>:<port> format
+  --token-file TOKEN_FILE
+                        file with access token
+  --cert-file CERT_FILE
+                        certificate to use as root CA
+  --wsid WSID           existing workspace ID, if not wanting to create a new one
+  --operation {set,get,set-all}
+                        whether to get or set inputs
+  --update-id UPDATE_ID
+                        Update ID from UpdateService call to set
+  --build-only BUILD_ONLY
+                        whether to stop after building the changes (no submission)
+```
+
+
+### Get the updates
+
+```shell
+python studio_onboarding.py --server www.arista.io:443 --token-file token.tok --build-only True
+
+Creating workspace "Accepting new devices and interfaces into I&T Studio"
+	WorkspaceID created: 5f88c496-71ca-469d-af19-2a17a5f5d583
+modified::CONNECTION::{"deviceId":"3AB1C9E6B1A1D4DC6B11990838D1D5E9","hostname":"ag-dc1-spine2","interfaceName":"Management0","newValue":{"neighborDeviceId":"D60EC473E29C51A45C50D84B9D89F756","neighborHostname":"ag-dc1-leaf1b","neighborInterfaceName":"Management0"},"oldValue":{"neighborDeviceId":"1207F35678E44BD8E7C7EC8BB18DDB8C","neighborHostname":"ag-dc1-leaf1a","neighborInterfaceName":"Management0"}}
+add::DEVICE::{"deviceId":"C7CEA9FC9030555D54E33DA26E0DC09B","hostname":"dc1-leaf2c","interfaceSize":1}
+add::DEVICE::{"deviceId":"ZZZ7777777","hostname":"leaf503","interfaceSize":73}
+remove::DEVICE::{"deviceId":"SN-dc1-leaf1","hostname":"dc1-leaf1","interfaceSize":6}
+remove::DEVICE::{"deviceId":"ZZZ9999999","hostname":"leaf401","interfaceSize":73}
+Building workspace
+	Build request 09e4c82c-173e-4c79-a235-ca2fd48ce2be sent
+	Waiting for build to complete
+	Build succeeded
+```
+
+### Accept all updates
+
+```shell
+python studio_onboarding.py --server www.arista.io:443 --token-file token.tok \
+    --wsid 5f88c496-71ca-469d-af19-2a17a5f5d583 --operation set-all
+```
+
+### Accept specific updates
+
+```shell
+python studio_onboarding.py --server www.cv-staging.corp.arista.io:443 --token-file token.tok \
+    --wsid 5f88c496-71ca-469d-af19-2a17a5f5d583 --operation set \
+    --update-id 'add::DEVICE::{"deviceId":"ZZZ7777777","hostname":"leaf503","interfaceSize":73}'
+```