Skip to content

Commit 0d24c2d

Browse files
zachcamara-hpezachcamara-hpe
committed
docs: ✨ 0.15.2-a1 release prep
1 parent c5924e1 commit 0d24c2d

File tree

7 files changed

+169
-10
lines changed

7 files changed

+169
-10
lines changed

‎.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ wheels/
2525
.installed.cfg
2626
*.egg
2727

28-
# Dev Tests
28+
# Dev
29+
.vscode
30+
31+
# Tests
2932
tests/dev
3033
.tox
3134

‎MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
exclude *.nix
22
exclude .pre-commit-config.yaml
33
include *.py
4-
include testing/*.py
4+
include tests/test*.py
55
include tox.ini
66
include *.md
77
include LICENSE

‎_version.py

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

‎docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# Main version number
1717
version = "0.15"
1818
# The full version, including alpha/beta/rc tags
19-
release = "0.15.1-a1"
19+
release = "0.15.2-a1"
2020

2121

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

‎docs/source/pyedgeconnect.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22
Module Documentation
33
===============================
44

5-
Module contents
6-
---------------
7-
8-
.. automodule:: pyedgeconnect
5+
Orchestrator
6+
----------------
7+
.. autoclass:: pyedgeconnect.Orchestrator
98
:members:
10-
:special-members: __init__
11-
:undoc-members:
129
:show-inheritance:
1310
:member-order: bysource
11+
12+
EdgeConnect
13+
----------------
14+
.. autoclass:: pyedgeconnect.EdgeConnect
15+
:members:
16+
:show-inheritance:
17+
:member-order: bysource

‎docs/source/release-notes/0.15.2-a1.rst

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
0.15.2-a1 -- 2022-07-29
2+
-----------------------
3+
4+
5+
🚀 Features
6+
~~~~~~~~~~~~~
7+
8+
- New code example: **upload security policy** - Upload Firewall
9+
Security Policies to an appliance or create a new Template Group to
10+
be assigned to appliances
11+
12+
- Overview: :doc:`/examples/upload_security_policy`
13+
- Code: `upload_security_policy <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples/upload_security_policy>`_
14+
15+
- Updated logging messages (when using ``log_console`` and ``log_file``
16+
parameters for EdgeConnect and Orchestrator) to include base Orch FQDN
17+
or ECOS FQDN to be clear when logging statements across different
18+
instances in a single script.
19+
20+
21+
Added the following EdgeConnect functions from Swagger:
22+
23+
from .ecos._alarm
24+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_alarms`
25+
- :func:`~pyedgeconnect.EdgeConnect.acknowledge_appliance_alarms`
26+
- :func:`~pyedgeconnect.EdgeConnect.clear_appliance_alarms`
27+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_alarm_descriptions`
28+
- :func:`~pyedgeconnect.EdgeConnect.add_note_appliance_alarms`
29+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_alarms`
30+
31+
from .ecos._bonded_tunnel
32+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_bonded_tunnels_state`
33+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_multiple_bonded_tunnels_state`
34+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_all_bonded_tunnel_ids`
35+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_bonded_tunnel_aliases`
36+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_bonded_tunnels_config`
37+
- :func:`~pyedgeconnect.EdgeConnect.configure_appliance_all_bonded_tunnels`
38+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_single_bonded_tunnel_config`
39+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_single_bonded_tunnel`
40+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_multiple_bonded_tunnels_config`
41+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_multiple_bonded_tunnels`
42+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_bonded_tunnel_live_view_info`
43+
44+
from .ecos._cli
45+
- :func:`~pyedgeconnect.EdgeConnect.perform_appliance_cli_command`
46+
- :func:`~pyedgeconnect.EdgeConnect.perform_appliance_multiple_cli_command`
47+
48+
from .ecos._deployment
49+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_deployment`
50+
51+
from .ecos._local_subnets
52+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_subnets`
53+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_subnets_all_vrfs`
54+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_subnets_single_vrf`
55+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_locally_configured_subnets`
56+
- :func:`~pyedgeconnect.EdgeConnect.update_appliance_all_locally_configured_subnets`
57+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_locally_configured_subnets_single_vrf`
58+
- :func:`~pyedgeconnect.EdgeConnect.update_appliance_all_locally_configured_subnets_single_vrf`
59+
- :func:`~pyedgeconnect.EdgeConnect.add_appliance_locally_configured_routes`
60+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_locally_configured_routes`
61+
- :func:`~pyedgeconnect.EdgeConnect.appliance_find_preferred_route`
62+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_routing_peers_info`
63+
64+
from .ecos._peers
65+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_peers`
66+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_peers_ec_only`
67+
68+
from .ecos._security_maps
69+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_security_policies`
70+
- :func:`~pyedgeconnect.EdgeConnect.configure_appliance_security_policies`
71+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_security_policy_map`
72+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_security_policy_zone_pair`
73+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_security_policy_zone_pair`
74+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_security_policy_rule`
75+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_security_policy_settings`
76+
- :func:`~pyedgeconnect.EdgeConnect.set_appliance_security_policy_settings`
77+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_security_policy_settings_by_map_name`
78+
79+
from .ecos._third_party_tunnel
80+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_3rdparty_tunnels_state`
81+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_multiple_3rdparty_tunnels_state`
82+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_all_3rdparty_tunnel_ids`
83+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_3rdparty_tunnel_aliases`
84+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_3rdparty_tunnels_config`
85+
- :func:`~pyedgeconnect.EdgeConnect.configure_appliance_multiple_3rdparty_tunnels`
86+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_single_3rdparty_tunnel_config`
87+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_single_3rdparty_tunnel`
88+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_multiple_3rdparty_tunnels_config`
89+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_multiple_3rdparty_tunnels`
90+
91+
from .ecos._tunnel
92+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_tunnels_config_and_state`
93+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_tunnels_config`
94+
- :func:`~pyedgeconnect.EdgeConnect.configure_appliance_all_tunnels`
95+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_single_tunnel_config`
96+
- :func:`~pyedgeconnect.EdgeConnect.configure_appliance_single_tunnel`
97+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_single_tunnel`
98+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_all_tunnel_ids`
99+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_tunnel_aliases`
100+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_multiple_tunnels_config`
101+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_multiple_tunnels_state`
102+
- :func:`~pyedgeconnect.EdgeConnect.configure_appliance_multiple_tunnels`
103+
- :func:`~pyedgeconnect.EdgeConnect.delete_appliance_multiple_tunnels`
104+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_tunnel_source_endpoints`
105+
- :func:`~pyedgeconnect.EdgeConnect.get_appliance_passthrough_tunnel_source_endpoints`
106+
- :func:`~pyedgeconnect.EdgeConnect.start_appliance_tunnel_mtu_discovery`
107+
- :func:`~pyedgeconnect.EdgeConnect.apply_appliance_tunnel_template`
108+
- :func:`~pyedgeconnect.EdgeConnect.set_appliance_tunnels_ipsec_psk`
109+
110+
111+
🐛 Bug Fixes
112+
~~~~~~~~~~~~~~
113+
114+
- `#10 <https://github.com/SPOpenSource/edgeconnect-python/issues/10>`_ -
115+
:func:`~pyedgeconnect.Orchestrator.login` and
116+
:func:`~pyedgeconnect.EdgeConnect.login` returned ``True`` even when
117+
login failed
118+
- `#11 <https://github.com/SPOpenSource/edgeconnect-python/issues/11>`_ -
119+
:func:`~pyedgeconnect.Orchestrator.appliance_resync` had incorrect
120+
endpoint of ``/applianceResyncSynchronize``, corrected to
121+
``/applianceResync``
122+
- `#12 <https://github.com/SPOpenSource/edgeconnect-python/issues/12>`_ -
123+
The preconfig generator example code had the option to look for a
124+
column for appliance serial number to match preconfig to, however,
125+
didn't include that information when creating the preconfig on
126+
Orchestrator as the parameter wasn't specified.
127+
- `#13 <https://github.com/SPOpenSource/edgeconnect-python/issues/13>`_ -
128+
Corrected return type-hint for methods that use `return_type="full_response"`
129+
with hint of requests.Response object rather than `dict`
130+
131+
132+
🧰 Maintenance / Other
133+
~~~~~~~~~~~~~~~~~~~~~~~
134+
135+
Introduced initial automated tox testing for Python 3.7, 3.8, 3.9, 3.10
136+
- run pytest tests
137+
138+
additional `testenv:format` environment
139+
- Check isort for imported packages
140+
- Check flake8
141+
142+
143+
🐛 Known Issues
144+
~~~~~~~~~~~~~~~
145+
146+
.. warning::
147+
148+
The following two functions for the _ip_objects submodule exprience
149+
errors at this time. These function do work in the Orchestrator UI:
150+
:func:`~pyedgeconnect.Orchestrator.bulk_upload_address_group` and
151+
:func:`~pyedgeconnect.Orchestrator.bulk_upload_service_group`

‎docs/source/release-notes/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ All of the release notes for pyedgeconnect are organized below
88
==================
99

1010
.. toctree::
11+
0.15.2-a1
1112
0.15.1-a1
1213
0.15.0-a1
1314
0.14.0-a2

0 commit comments

Comments
 (0)