Skip to content

Commit

Permalink
release 0.15.4-a1
Browse files Browse the repository at this point in the history
  • Loading branch information
zachcamara-hpe committed Jan 31, 2023
2 parents c41f92b + c81a326 commit a89159e
Show file tree
Hide file tree
Showing 36 changed files with 1,374 additions and 59 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 SPOpenSource
(C) Copyright 2023 Hewlett Packard Enterprise Development LP.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To install the most recent version of pyedgeconnect, open an
interactive shell and run:

```bash
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python
$ pip install git+https://github.com/aruba/pyedgeconnect
...
$ pip list
Package Version
Expand All @@ -69,10 +69,10 @@ interactive shell and run:
To install a specific branch use the @branch syntax

```bash
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
$ pip install git+https://github.com/aruba/pyedgeconnect@<branch_name>
...
# Install the Development branch
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@development
$ pip install git+https://github.com/aruba/pyedgeconnect@development
...
```

Expand All @@ -88,7 +88,7 @@ following syntax:
```bash
$ pip install pyedgeconnect[dev]
or
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python#egg=pyedgeconnect[dev]
$ pip install git+https://github.com/aruba/pyedgeconnect#egg=pyedgeconnect[dev]
```

## Docs
Expand All @@ -101,7 +101,7 @@ To build the documentation locally, clone the repository, install with ``[dev]``
to include sphinx and related packages, then in the docs directory run ``make html``

```bash
git clone https://github.com/SPOpenSource/edgeconnect-python.git
git clone https://github.com/aruba/pyedgeconnect.git
cd edgeconnect-python
pip install .[dev]
cd docs
Expand Down
2 changes: 1 addition & 1 deletion _version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version = "0.15.3a1.dev0"
version = "0.15.4a1.dev0"
Binary file added docs/source/_static/hpe_aruba_black_pos_rgb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Main version number
version = "0.15"
# The full version, including alpha/beta/rc tags
release = "0.15.3-a1"
release = "0.15.4-a1"


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -46,7 +46,7 @@
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_logo = "_static/aruba_small_use_logo.png"
html_logo = "_static/hpe_aruba_black_pos_rgb.png"


# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
4 changes: 2 additions & 2 deletions docs/source/examples/auth_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ addition to any other required logic for a particular use-case.

The code referenced in this document and all published examples
with pyedgeconnect are available from the GitHub repository within the
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
`examples <https://github.com/aruba/pyedgeconnect/tree/main/examples>`_
folder. Each example script contains logic to authenticate to the
Orchestrator as documented in the authentication example.

Clone the repository and download the examples with:

.. code:: bash
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
$ git clone https://github.com/aruba/pyedgeconnect.git
Environment variables
Expand Down
4 changes: 2 additions & 2 deletions docs/source/examples/basic_examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

The code referenced in this document and all published examples
with pyedgeconnect are available from the GitHub repository within the
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
`examples <https://github.com/aruba/pyedgeconnect/tree/main/examples>`_
folder. Each example script contains logic to authenticate to the
Orchestrator as documented in the authentication example.

Clone the repository and download the examples with:

.. code:: bash
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
$ git clone https://github.com/aruba/pyedgeconnect.git
Print Appliance Information
Expand Down
12 changes: 10 additions & 2 deletions docs/source/examples/ec_telemetry_demo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ EdgeConnect Telemetry API Demo

The code referenced in this document and all published examples
with pyedgeconnect are available from the GitHub repository within the
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
`examples <https://github.com/aruba/pyedgeconnect/tree/main/examples>`_
folder. Each example script contains logic to authenticate to the
Orchestrator as documented in the authentication example.

Clone the repository and download the examples with:

.. code:: bash
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
$ git clone https://github.com/aruba/pyedgeconnect.git
Overview and System Prerequisites
-----------------------------------
Expand Down Expand Up @@ -433,6 +433,13 @@ Visualize Data in Grafana
Required Configuration To Run Demo
-----------------------------------

.. note::

If data is not populating in the Dashboards, check the recent log
file ``ec-telemetry.log`` in ``app/logging`` on the demo host. Here
you can find log messages related to the data collection worker
containers.

Environment Variables
==========================

Expand Down Expand Up @@ -473,6 +480,7 @@ up -d``
# DB_USER and DB_PW used to login to both Grafana/InfluxDB
DB_TOKEN=<database_token>
DB_USER=admin
# DB_PW must be > 8 characters to meet minimum requirements
DB_PW=<database_password>
# Number of replica containers for ec-telemetry-worker
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/source/examples/generate_preconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@

The code referenced in this document and all published examples
with pyedgeconnect are available from the GitHub repository within the
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
`examples <https://github.com/aruba/pyedgeconnect/tree/main/examples>`_
folder. Each example script contains logic to authenticate to the
Orchestrator as documented in the authentication example.

Clone the repository and download the examples with:

.. code:: bash
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
$ git clone https://github.com/aruba/pyedgeconnect.git
Generate EdgeConnect Preconfig
********************************
Expand Down
5 changes: 3 additions & 2 deletions docs/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Example Code from Repository

All examples documented in this section are available from the
GitHub repository within the
`examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
`examples <https://github.com/aruba/pyedgeconnect/tree/main/examples>`_
folder:

Clone the repository and download the examples with:

.. code:: bash
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
$ git clone https://github.com/aruba/pyedgeconnect.git
Example script documentation and instructions
Expand All @@ -23,4 +23,5 @@ Example script documentation and instructions
basic_examples
generate_preconfig
upload_security_policy
update_port_forwarding
ec_telemetry_demo
Loading

0 comments on commit a89159e

Please sign in to comment.