Skip to content

Commit

Permalink
Preparing release 2023.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mirceaulinic committed Aug 2, 2023
1 parent 41f3385 commit 8eea551
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 15 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2019-2020 Mircea Ulinic
Copyright 2019-2023 Mircea Ulinic

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,8 @@ Docker
------

A Docker image is available at
https://hub.docker.com/r/mirceaulinic/salt-sproxy, and you can pull it, e.g.,
``docker pull mirceaulinic/salt-sproxy``. See
https://github.com/mirceaulinic/salt-sproxy/pkgs/container/salt-sproxy, and you can pull it, e.g.,
``docker pull ghcr.io/mirceaulinic/salt-sproxy:develop``. See
https://salt-sproxy.readthedocs.io/en/latest/#docker for further usage
instructions and examples.

Expand Down
36 changes: 36 additions & 0 deletions docs/releases/2023.8.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _release-2023.8.0:

================
Release 2023.8.0
================

While this release doesn't necessarily bring any new features, it fixes various
compatibility issues with recent Salt releases, starting with Salt 3004:

- `Chris Hills <https://github.com/Chaz6>`__: https://github.com/mirceaulinic/salt-sproxy/pull/264
- `Zpell82 <https://github.com/Zpell82>`__: https://github.com/mirceaulinic/salt-sproxy/pull/270
- https://github.com/mirceaulinic/salt-sproxy/pull/266
- https://github.com/mirceaulinic/salt-sproxy/pull/265

.. important::

Beginning with Salt release 3006, in order to have enable the ``sproxy``
and ``sproxy_async`` clients, you need to explicitly list them under the
``netapi_enable_clients`` configuration option, otherwise, Salt will reject
any API requests to either of these.
See
https://docs.saltproject.io/en/master/topics/netapi/netapi-enable-clients.html
for more details.

Example: ``/etc/salt/master``

.. code-block:: yaml
netapi_enable_clients:
- local
- local_async
- sproxy
- sproxy_async
See also https://salt-sproxy.readthedocs.io/en/latest/salt_api.html for
more documentation notes.
3 changes: 2 additions & 1 deletion docs/releases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ Latest Release
.. toctree::
:maxdepth: 1

2021.6.0
2023.8.0

Previous Releases
^^^^^^^^^^^^^^^^^

.. toctree::
:maxdepth: 1

2021.6.0
2020.10.0
2020.7.0
2020.3.0
Expand Down
20 changes: 20 additions & 0 deletions docs/salt_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,26 @@ together with *salt-sproxy*. Everything stay the exact same as usually, the
only difference being the special ``sproxy`` and ``sproxy_async`` clients for
simplified usage.

.. important::

Beginning with Salt release 3006, in order to have enable the ``sproxy``
and ``sproxy_async`` clients, you need to explicitly list them under the
``netapi_enable_clients`` configuration option, otherwise, Salt will reject
any API requests to either of these.
See
https://docs.saltproject.io/en/master/topics/netapi/netapi-enable-clients.html
for more details.

Example: ``/etc/salt/master``

.. code-block:: yaml
netapi_enable_clients:
- local
- local_async
- sproxy
- sproxy_async
A major advantage of using the ``sproxy`` / ``sproxy_async`` clients is that
the usage is very similar to the ``local`` / ``local_async`` clients (see
https://docs.saltstack.com/en/latest/ref/netapi/all/salt.netapi.rest_cherrypy.html#usage),
Expand Down
3 changes: 0 additions & 3 deletions pypi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ Salt plugin for interacting with network devices, without running Minions.

This is NOT a SaltStack product.

This package may eventually be integrated in a future version of the
official Salt releases, in this form or slightly different.

Install
-------

Expand Down
15 changes: 7 additions & 8 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

setup(
name=name,
version="2022.10.0",
version="2023.8.0",
namespace_packages=["salt_sproxy"],
packages=find_packages(),
author="Mircea Ulinic",
Expand All @@ -40,13 +40,12 @@
"Topic :: System :: Systems Administration",
"Programming Language :: Python",
"Programming Language :: Cython",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Operating System :: POSIX",
"Operating System :: Microsoft :: Windows",
"Operating System :: MacOS",
Expand Down Expand Up @@ -82,7 +81,7 @@
]
},
extras_require={
"api": ["cherrypy"],
"api": ["cherrypy>=18.8.0"],
"netbox": ["pynetbox"],
"napalm": ["napalm"],
"junos": ["junos-eznc"],
Expand Down

0 comments on commit 8eea551

Please sign in to comment.