python3-cyberfusion-cluster-support
API library for Core API.
Install
PyPI
Run the following command to install the package from PyPI:
pip3 install python3-cyberfusion-cluster-support
Debian
Run the following commands to build a Debian package:
mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
dpkg-buildpackage -us -uc
Configure
Config file options
- Section
clusterapi, keyclusterid. Only objects belonging to the specified cluster are loaded. - Section
clusterapi, keyserviceaccountid. Only objects belonging to a cluster for which a service account to cluster exists for the specified service account are loaded.
Class options
config_file_path. Non-default config file path.cluster_ids. Only objects belonging to the specified clusters are loaded.
Cluster IDs: order of precedence
The cluster_ids class option takes precedence over the clusterid config file option.
If neither is set, all objects are loaded.
If the clusterid config file option is set, but you want to load all objects, setting the cluster_ids class option to None (default) will not work. Instead, use the sentinel value cyberfusion.ClusterSupport.ALL_CLUSTERS.
Usage
Basic
from cyberfusion.ClusterSupport import ClusterSupport
s = ClusterSupport()
Read
API objects without parameters
Some API objects do not require parameters to be retrieved.
These API objects are retrieved from the Core API once. They are then cached.
Examples:
print(s.database_users)
print(s.unix_users)
print(s.fpm_pools)
API objects with parameters
Some API objects require parameters to be retrieved.
These API objects are retrieved from the Core API on every call.
Example:
print(s.access_logs(virtual_host_id=s.virtual_hosts[0].id, ...))
Update
Example:
d = s.database_users[0]
d.password = "newpassword"
d.update()
Create
Example:
from cyberfusion.ClusterSupport import ClusterSupport
from cyberfusion.ClusterSupport.certificates import Certificate
s = ClusterSupport()
c = Certificate(s)
assert c.id is None
c.create(common_names=["domlimev.nl", "www.domlimev.nl"])
assert c.id is not None
assert c.common_names == common_names=["domlimev.nl", "www.domlimev.nl"]
Delete
Example:
from cyberfusion.ClusterSupport import ClusterSupport
s = ClusterSupport()
c = s.certificates[0]
c.delete()
Tests
Tests with cassettes
Tests re-use cassettes. Tests run with PyCharm automatically (re)write cassettes.
1 maintainer
Release files for python3-cyberfusion-cluster-support 3.9.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| python3_cyberfusion_cluster_support-3.9.2.tar.gz | 62.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| python3_cyberfusion_cluster_support-3.9.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 196.7 kB
Release files / python3_cyberfusion_cluster_support-3.9.2.tar.gz
| Download URL | python3_cyberfusion_cluster_support-3.9.2.tar.gz |
|---|---|
| Size | 62.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
66f5763e7f1598d161ebe0cee224632502fd6665057ddaba22f493ae1fe0e102
|
|
BLAKE2b-256 checksum How to use checksums |
3a5ff6b366588c87e91a21bcae6c6d4216d91fc8d0279b215aeec005ec5cc8b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / python3_cyberfusion_cluster_support-3.9.2-py3-none-any.whl
| Download URL | python3_cyberfusion_cluster_support-3.9.2-py3-none-any.whl |
|---|---|
| Size | 134.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
faf8158dac445d27fcbbc7d3d4b62d1d388e24d875929eeeb7607676a9226bb3
|
|
BLAKE2b-256 checksum How to use checksums |
214e589da53a99c5b07b7c961b5a98e9a538b6b15915698aa0d8df4de537e0ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
