***************
Idem_vmware_alb
***************
.. image:: https://img.shields.io/badge/made%20with-idem-teal
:alt: Made with idem, a Python implementation of Plugin Oriented Programming
:target: https://www.idemproject.io/
.. image:: https://img.shields.io/badge/docs%20on-docs.idemproject.io-blue
:alt: Documentation is published with Sphinx on docs.idemproject.io
:target: https://docs.idemproject.io/idem_vmware_alb/en/latest/index.html
.. image:: https://img.shields.io/badge/made%20with-pop-teal
:alt: Made with pop, a Python implementation of Plugin Oriented Programming
:target: https://pop.readthedocs.io/
.. image:: https://img.shields.io/badge/made%20with-python-yellow
:alt: Made with Python
:target: https://www.python.org/
About
=====
avilb Cloud Provider for Idem
* `idem_vmware_alb source code <https://gitlab.com/vmware/idem/idem-vmware-alb>`__
* `idem_vmware_alb documentation <https://docs.idemproject.io/idem_vmware_alb/en/latest/index.html>`__
What is Idem?
-------------
This project is built with `idem <https://www.idemproject.io/>`__, an idempotent,
imperatively executed, declarative programming language written in Python. This project extends
idem!
For more information:
* `Idem Project Website <https://www.idemproject.io/>`__
* `Idem Project docs portal <https://docs.idemproject.io/>`__
Getting Started
===============
Prerequisites
-------------
* Python 3.8+
* git *(if installing from source, or contributing to the project)*
Installation
------------
.. note::
If wanting to contribute to the project, and setup your local development
environment, see the ``CONTRIBUTING.rst`` document in the source repository
for this project.
You can install ``idem_vmware_alb`` either from PyPI or from source.
Install from PyPI
+++++++++++++++++
.. code-block:: bash
pip install "idem_vmware_alb"
Install from source
+++++++++++++++++++
Clone the ``idem_vmware_alb`` repository and install with pip.
.. code-block:: bash
# clone repo
git clone git@<your-project-path>/idem_vmware_alb.git
cd idem_vmware_alb
# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e idem_vmware_alb
Setup
=====
After installation avilb idem provider execution and state modules will be accessible to the pop `hub`.
In order to use them we need to set up our credentials.
Create a new file called `credentials.yaml` and populate it with profiles.
The `default` profile will be used automatically by `idem` unless you specify one with `--acct-profile=profile_name` on the cli.
credentials.yaml
.. code:: sls
avilb:
default:
username: my_user
password: my_good_password
endpoint_url: https://console.avilb.com/api
Now encrypt the credentials file and add the encryption key and encrypted file path to the ENVIRONMENT.
.. code:: bash
idem encrypt credentials.yaml
output::
-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI=
Add these to your environment:
.. code:: bash
export ACCT_KEY="-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI="
export ACCT_FILE=$PWD/credentials.yaml.fernet
You are ready to use ``idem_vmware_alb``!
State Example
=============
Example of using avilb state in SLS:
my_state.sls:
.. code:: sls
ensure_sample_exists:
avilb.sample.present:
- name: a_sample_name
- description: Managed by Idem
Create sample state:
.. code:: bash
idem state my_state.sls
Delete sample state:
.. code:: bash
idem state my_state.sls --invert
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/vmware/idem/idem-vmware-alb",
"name": "idem-vmware-alb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "VMware, Inc.",
"author_email": "idemproject@vmware.com",
"download_url": "https://files.pythonhosted.org/packages/b0/2e/f7bcd2eeb351fe78d652581d9677e21e9dbeda1217db302d6594eb77b779/idem_vmware_alb-0.9.1.tar.gz",
"platform": null,
"description": "***************\nIdem_vmware_alb\n***************\n\n.. image:: https://img.shields.io/badge/made%20with-idem-teal\n :alt: Made with idem, a Python implementation of Plugin Oriented Programming\n :target: https://www.idemproject.io/\n\n.. image:: https://img.shields.io/badge/docs%20on-docs.idemproject.io-blue\n :alt: Documentation is published with Sphinx on docs.idemproject.io\n :target: https://docs.idemproject.io/idem_vmware_alb/en/latest/index.html\n\n.. image:: https://img.shields.io/badge/made%20with-pop-teal\n :alt: Made with pop, a Python implementation of Plugin Oriented Programming\n :target: https://pop.readthedocs.io/\n\n.. image:: https://img.shields.io/badge/made%20with-python-yellow\n :alt: Made with Python\n :target: https://www.python.org/\n\nAbout\n=====\n\navilb Cloud Provider for Idem\n\n* `idem_vmware_alb source code <https://gitlab.com/vmware/idem/idem-vmware-alb>`__\n* `idem_vmware_alb documentation <https://docs.idemproject.io/idem_vmware_alb/en/latest/index.html>`__\n\nWhat is Idem?\n-------------\n\nThis project is built with `idem <https://www.idemproject.io/>`__, an idempotent,\nimperatively executed, declarative programming language written in Python. This project extends\nidem!\n\nFor more information:\n\n* `Idem Project Website <https://www.idemproject.io/>`__\n* `Idem Project docs portal <https://docs.idemproject.io/>`__\n\nGetting Started\n===============\n\nPrerequisites\n-------------\n\n* Python 3.8+\n* git *(if installing from source, or contributing to the project)*\n\nInstallation\n------------\n\n.. note::\n\n If wanting to contribute to the project, and setup your local development\n environment, see the ``CONTRIBUTING.rst`` document in the source repository\n for this project.\n\nYou can install ``idem_vmware_alb`` either from PyPI or from source.\n\nInstall from PyPI\n+++++++++++++++++\n\n.. code-block:: bash\n\n pip install \"idem_vmware_alb\"\n\nInstall from source\n+++++++++++++++++++\n\nClone the ``idem_vmware_alb`` repository and install with pip.\n\n.. code-block:: bash\n\n # clone repo\n git clone git@<your-project-path>/idem_vmware_alb.git\n cd idem_vmware_alb\n\n # Setup venv\n python3 -m venv .venv\n source .venv/bin/activate\n pip install -e idem_vmware_alb\n\nSetup\n=====\n\nAfter installation avilb idem provider execution and state modules will be accessible to the pop `hub`.\nIn order to use them we need to set up our credentials.\n\nCreate a new file called `credentials.yaml` and populate it with profiles.\nThe `default` profile will be used automatically by `idem` unless you specify one with `--acct-profile=profile_name` on the cli.\n\ncredentials.yaml\n\n.. code:: sls\n\n avilb:\n default:\n username: my_user\n password: my_good_password\n endpoint_url: https://console.avilb.com/api\n\nNow encrypt the credentials file and add the encryption key and encrypted file path to the ENVIRONMENT.\n\n.. code:: bash\n\n idem encrypt credentials.yaml\n\noutput::\n\n -A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI=\n\nAdd these to your environment:\n\n.. code:: bash\n\n export ACCT_KEY=\"-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI=\"\n export ACCT_FILE=$PWD/credentials.yaml.fernet\n\nYou are ready to use ``idem_vmware_alb``!\n\nState Example\n=============\n\nExample of using avilb state in SLS:\n\nmy_state.sls:\n\n.. code:: sls\n\n ensure_sample_exists:\n avilb.sample.present:\n - name: a_sample_name\n - description: Managed by Idem\n\nCreate sample state:\n\n.. code:: bash\n\n idem state my_state.sls\n\nDelete sample state:\n\n.. code:: bash\n\n idem state my_state.sls --invert\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "VMware ALB Provider for Idem",
"version": "0.9.1",
"project_urls": {
"Code": "https://gitlab.com/vmware/idem/idem-vmware-alb",
"Homepage": "https://gitlab.com/vmware/idem/idem-vmware-alb",
"Issue tracker": "https://gitlab.com/vmware/idem/idem-vmware-alb/-/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "pypi",
"digests": {
"blake2b_256": "0fe34bfb3a8683401b0c0420150edfe38a9be9d0adc1fb96e94f56f53aad45a0",
"md5": "b16085784b2ea1317816a26c5427eb47",
"sha256": "e8e00ae2509bbeb8849653df862cb53fcfa7921758323766ab18e5745d2db63b"
},
"downloads": -1,
"filename": "idem_vmware_alb-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b16085784b2ea1317816a26c5427eb47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 401416,
"upload_time": "2023-12-21T09:24:30",
"upload_time_iso_8601": "2023-12-21T09:24:30.298099Z",
"url": "https://files.pythonhosted.org/packages/0f/e3/4bfb3a8683401b0c0420150edfe38a9be9d0adc1fb96e94f56f53aad45a0/idem_vmware_alb-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "pypi",
"digests": {
"blake2b_256": "b02ef7bcd2eeb351fe78d652581d9677e21e9dbeda1217db302d6594eb77b779",
"md5": "e71b1d1c238f1312753711e760b01ecc",
"sha256": "f4c6532def19fbc335dc4ff5c90913a5d3253b62f985ccbfe92b07a252f1b3e8"
},
"downloads": -1,
"filename": "idem_vmware_alb-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "e71b1d1c238f1312753711e760b01ecc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 381134,
"upload_time": "2023-12-21T09:24:36",
"upload_time_iso_8601": "2023-12-21T09:24:36.189407Z",
"url": "https://files.pythonhosted.org/packages/b0/2e/f7bcd2eeb351fe78d652581d9677e21e9dbeda1217db302d6594eb77b779/idem_vmware_alb-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-21 09:24:36",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "vmware",
"gitlab_project": "idem",
"lcname": "idem-vmware-alb"
}
JSON