please add documentation and example for python-zunclient API

The request for documentation is valid. We will improve the documentation for python-zunclient although I have a question on the example above.

The code you provided is using openstacksdk (not python-zunclient) to consume Zun's API. Do you prefer to use openstacksdk instead? I am not sure if Zun is supported in there but we can work on openstacksdk if this is the preferred way to consume the Zun's service. Looking forward to your remark.

Hi Hongbin,

I don't have any preference for openstacksdk vs python-zunclient. I will try whichever you recommend.

Below is my attempt to use python-zunclient:

#!/usr/bin/env python
import zunclient.v1.containers
mgr = zunclient.v1.containers.ContainerManager()
mgr.list()

It said:

Traceback (most recent call last):
  File "test2.py", line 3, in <module>
    mgr = zunclient.v1.containers.ContainerManager()
TypeError: __init__() takes exactly 2 arguments (1 given)

Since ContainerManager inherits from base.Manager, I considered this code:

class Manager(object):
    """Provides CRUD operations with a particular API."""
    resource_class = None

    def __init__(self, api):
        self.api = api

So I think the problem is that I need to pass to ContainerManager() the argument list for the above __init__. But I could not figure out what to pass for api. Can you help me with that?

Thanks.

Below is the script I tried and it worked for me (I borrowed it from python-novaclient https://docs.openstack.org/python-novaclient/latest/reference/api/index.html):

from keystoneauth1 import loading
from keystoneauth1 import session
from zunclient import client

AUTH_URL='http://192.168.38.12/identity'
USERNAME='demo'
PASSWORD='XXX'
PROJECT_NAME='demo'
VERSION='1.latest' # master -> 1.latest, stable/rocky -> 1.26, stable/queens -> 1.12

loader = loading.get_plugin_loader('password')
auth = loader.load_from_options(auth_url=AUTH_URL,
                                username=USERNAME,
                                password=PASSWORD,
                                project_name=PROJECT_NAME,
                                user_domain_name='default',
                                project_domain_name='default')
sess = session.Session(auth=auth)
zun = client.Client(VERSION, session=sess)
containers = zun.containers.list()
print(containers)

And I believe 'ContainerManager' is for internal use. 'Client' is the class for external.

The only thing that was difficult was that in AUTH_URL, I changed /identity to :5000/v3

It worked great!

Thank you!

The documentation will be online once this patch is merged: https://review.openstack.org/#/c/616069/

Done: https://docs.openstack.org/python-zunclient/latest/user/python-api.html

This issue was fixed in the openstack/python-zunclient 3.3.0 release.