Skip to content

Commit c41f92b

Browse files
zachcamara-hpezachcamara-hpe
authored
Merge pull request #16 from SPOpenSource/release/0.15.3-a1
Release/0.15.3 a1
2 parents b2343a1 + 8664af1 commit c41f92b

48 files changed

Lines changed: 13157 additions & 104 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,31 @@ wheels/
2424
*.egg-info/
2525
.installed.cfg
2626
*.egg
27+
_version.py
2728

2829
# Dev
2930
.vscode
3031

3132
# Tests
32-
tests/dev
3333
.tox
3434

3535
# Documentation
3636
docs/build/
3737
docs/source/_build
38-
examples/generate_preconfig/preconfig_outputs
3938

4039
# dotenv
4140
*.env
4241

42+
# Code Examples
43+
examples/generate_preconfig/preconfig_outputs
44+
examples/edgeconnect-telemetry-demo/app/grafana/data
45+
examples/edgeconnect-telemetry-demo/app/influxdb/data
46+
examples/edgeconnect-telemetry-demo/app/influxdb/config
47+
examples/edgeconnect-telemetry-demo/app/redis
48+
examples/edgeconnect-telemetry-demo/app/worker
49+
examples/edgeconnect-telemetry-demo/app/logging/
50+
!example.env
51+
4352
# Virtual Environment
4453
.venv/
4554

‎_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version = "0.15.2a2.dev0"
1+
version = "0.15.3a1.dev0"

‎docs/source/_static/aruba_small_use_logo.png‎

23.3 KB
Loading

‎docs/source/_static/css/pyedgeconnect.css‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
/* Nav Search Background */
2+
.wy-side-nav-search {
3+
background-color: #FF8300
4+
}
5+
6+
.wy-side-nav-search .wy-dropdown>a img.logo,
7+
.wy-side-nav-search>a img.logo {
8+
width: 125px;
9+
}
10+
11+
/* Menu Title Color */
12+
.wy-menu-vertical p.caption {
13+
color: #FF8300;
14+
}
15+
16+
/* Content background */
17+
.wy-nav-content {
18+
margin: 0;
19+
background: #0F3250;
20+
}
21+
22+
/* Outer background */
23+
.wy-nav-content-wrap {
24+
background: #343131;
25+
}
26+
27+
/* Body Text Color */
28+
body {
29+
color: #dbdce1;
30+
}
31+
32+
dd {
33+
display: block;
34+
margin-inline-start: 0px;
35+
}
36+
37+
/* Header Text Color */
38+
.rst-content .toctree-wrapper>p.caption,
39+
h1,
40+
h2,
41+
h3,
42+
h4,
43+
h5,
44+
h6,
45+
legend {
46+
color: #FFFFFF;
47+
}
48+
49+
/* Notes, Warnings, Important Colors */
50+
.rst-content .note .admonition-title {
51+
background: rgba(53, 139, 193, 1)
52+
}
53+
54+
.rst-content .note {
55+
background: rgba(53, 139, 193, 0.5)
56+
}
57+
58+
.rst-content .warning .admonition-title {
59+
background: rgba(193, 53, 53, 1)
60+
}
61+
62+
.rst-content .warning {
63+
background: rgba(193, 53, 53, 0.5)
64+
}
65+
66+
.rst-content .important .admonition-title {
67+
background: rgba(255, 131, 0, 1)
68+
}
69+
70+
.rst-content .important {
71+
background: rgba(255, 131, 0, 0.7)
72+
}
73+
74+
75+
/* Code Highlight */
76+
.highlight {
77+
color: #ADE1F0;
78+
background: #04121e;
79+
}
80+
81+
.highlight .s1 {
82+
color: #FF8300;
83+
}
84+
85+
.highlight .s2 {
86+
color: #FF8300;
87+
}
88+
89+
.highlight .sd {
90+
color: #FF8300;
91+
}
92+
93+
.rst-content div[class^=highlight],
94+
.rst-content pre.literal-block {
95+
border: none
96+
}
97+
98+
99+
.rst-content code.literal,
100+
.rst-content tt.literal {
101+
color: #ADE1F0;
102+
background: #04121e;
103+
border: none;
104+
}
105+
106+
.rst-content code.xref,
107+
.rst-content tt.xref,
108+
a .rst-content code,
109+
a .rst-content tt {
110+
font-weight: 900;
111+
}
112+
113+
114+
/* Table Text */
115+
.rst-content table.docutils caption,
116+
.rst-content table.field-list caption,
117+
.wy-table caption {
118+
color: #ADE1F0;
119+
}
120+
121+
.rst-content table.docutils thead,
122+
.rst-content table.field-list thead,
123+
.wy-table thead {
124+
color: #ADE1F0;
125+
}
126+
127+
.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
128+
.wy-table-backed,
129+
.wy-table-odd td,
130+
.wy-table-striped tr:nth-child(2n-1) td {
131+
background-color: #184369;
132+
}
133+
134+
/* Module Content */
135+
136+
html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,
137+
html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name {
138+
color: #0F3250;
139+
}
140+
141+
strong {
142+
color: #ADE1F0;
143+
}

‎docs/source/conf.py‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Configuration file for the Sphinx documentation builder.
2-
#
2+
33
import os
44
import sys
55

@@ -16,15 +16,20 @@
1616
# Main version number
1717
version = "0.15"
1818
# The full version, including alpha/beta/rc tags
19-
release = "0.15.2-a1"
19+
release = "0.15.3-a1"
2020

2121

2222
# -- General configuration ---------------------------------------------------
2323

2424
# Add any Sphinx extension module names here, as strings. They can be
2525
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2626
# ones.
27-
extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"]
27+
extensions = [
28+
"sphinx.ext.todo",
29+
"sphinx.ext.viewcode",
30+
"sphinx.ext.autodoc",
31+
"sphinx.ext.viewcode",
32+
]
2833

2934
# Add any paths that contain templates here, relative to this directory.
3035
templates_path = ["_templates"]
@@ -40,10 +45,15 @@
4045
# The theme to use for HTML and HTML Help pages. See the documentation for
4146
# a list of builtin themes.
4247
#
43-
# html_theme = 'alabaster'
4448
html_theme = "sphinx_rtd_theme"
49+
html_logo = "_static/aruba_small_use_logo.png"
50+
4551

4652
# Add any paths that contain custom static files (such as style sheets) here,
4753
# relative to this directory. They are copied after the builtin static files,
4854
# so a file named "default.css" will overwrite the builtin "default.css".
4955
html_static_path = ["_static"]
56+
57+
58+
def setup(app):
59+
app.add_css_file("css/pyedgeconnect.css")

‎docs/source/examples/auth_example.rst‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
.. auth_example:
22
3-
============================
4-
Authentication
5-
============================
3+
4+
Authentication
5+
********************************
66

77
The following code snippet is an example of handling multiple authentication
88
methods when connecting to an Aruba Orchestrator instance with pyedgeconnect.
99

1010
The example scripts provided in the repository use this process in
1111
addition to any other required logic for a particular use-case.
1212

13+
.. note::
14+
15+
The code referenced in this document and all published examples
16+
with pyedgeconnect are available from the GitHub repository within the
17+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
18+
folder. Each example script contains logic to authenticate to the
19+
Orchestrator as documented in the authentication example.
20+
21+
Clone the repository and download the examples with:
22+
23+
.. code:: bash
24+
25+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
1326
1427
1528
Environment variables
@@ -23,12 +36,12 @@ related to authenticating to Orchestrator
2336
``ORCH_USER``
2437
``ORCH_PASSWORD``
2538

26-
If ORCH_URL is specified, it will take precedence, otherwise user will
27-
be prompted for input to enter the Orchestrator IP or FQDN
39+
If ``ORCH_URL`` is specified, it will take precedence, otherwise user
40+
will be prompted for input to enter the Orchestrator IP or FQDN
2841

29-
If ORCH_API_KEY is specified it will take precedence for an authentication
30-
method over user/password authentication. If not found, the user will be
31-
prompted for entering an API key.
42+
If ``ORCH_API_KEY`` is specified it will take precedence for an
43+
authentication method over user/password authentication. If not found,
44+
the user will be prompted for entering an API key.
3245

3346
.. code-block:: python
3447

‎docs/source/examples/basic_examples.rst‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
.. basic_examples:
22
33
4-
The following examples are also included as individual .py files in the
5-
repository in the `examples` directory. Each example script contains
6-
logic to authenticate to the Orchestrator as documented in the
7-
authentication example.
4+
.. note::
5+
6+
The code referenced in this document and all published examples
7+
with pyedgeconnect are available from the GitHub repository within the
8+
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
9+
folder. Each example script contains logic to authenticate to the
10+
Orchestrator as documented in the authentication example.
11+
12+
Clone the repository and download the examples with:
13+
14+
.. code:: bash
15+
16+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
817
918
1019
Print Appliance Information
11-
===========================
20+
------------------------------
1221

1322
This example retrieves all the appliances currently in Orchestrator
1423
and then prints the appliances and certain attributes into a table in
@@ -80,7 +89,7 @@ the terminal output.
8089
8190
8291
Run Packet Capture
83-
==================
92+
-----------------------
8493

8594
This example will run a tcpdump packet capture on the specified
8695
appliance and then upload the file to Orchestrator so that it can be
@@ -149,8 +158,8 @@ downloaded by the user or uploaded to support.
149158
pass
150159
151160
152-
Create User
153-
==================
161+
Create Local Orchestrator User
162+
--------------------------------
154163

155164
This example will create a new user read-only user
156165
locally on Orchestrator.

0 commit comments

Comments
 (0)