Cloudfoundry python client
The cf-python-client repo contains a Python client library for Cloud Foundry.
Installing
Supported versions
| warning: | Starting version 1.11.0, versions older that python 3.6.0 will not be supported anymore. This late version was released by the end 2016. |
|---|
For those that are still using python 2.7, it won't be supported by the end of 2020 and all library shall stop supporting it.
From pip
$ pip install cloudfoundry-client
From sources
To build the library run :
$ python setup.py install
Run the client
To run the client, enter the following command :
$ cloudfoundry-client
This will explains you how the client works. At first execution, it will ask you information about the platform you want to reach (url, login and so on). Please note that your credentials won't be saved on your disk: only tokens will be kept for further use.
Use the client in your code
You may build the client and use it in your code
Client
To instantiate the client, nothing easier
from cloudfoundry_client.client import CloudFoundryClient
target_endpoint = 'https://somewhere.org'
proxy = dict(http=os.environ.get('HTTP_PROXY', ''), https=os.environ.get('HTTPS_PROXY', ''))
client = CloudFoundryClient(target_endpoint, proxy=proxy, verify=False)
# init with user credentials
client.init_with_user_credentials('login', 'password')
# init with refresh token (that will retrieve a fresh access token)
client.init_with_token('refresh-token')
# init with access and refresh token (if the above method is not convenient)
client.refresh_token = 'refresh-token'
client._access_token = 'access-token'
It can also be instantiated with oauth code flow if you possess a dedicated oauth application with its redirection
from flask import request
from cloudfoundry_client.client import CloudFoundryClient
target_endpoint = 'https://somewhere.org'
proxy = dict(http=os.environ.get('HTTP_PROXY', ''), https=os.environ.get('HTTPS_PROXY', ''))
client = CloudFoundryClient(target_endpoint, proxy=proxy, verify=False, client_id='my-client-id', client_secret='my-client-secret')
@app.route('/login')
def login():
global client
return redirect(client.generate_authorize_url('http://localhost:9999/code', '666'))
@app.route('/code')
def code():
global client
client.init_authorize_code_process('http://localhost:9999/code', request.args.get('code'))
And then you can use it as follows:
for organization in client.v2.organizations:
print(organization['metadata']['guid'])
API V2
Entities
Entities returned by api V2 calls (organization, space, app..) are navigable ie you can call the method associated with the xxx_url entity attribute (note that if the attribute's name ends with a list, it will be interpreted as a list of object. Other wise you will get a single entity).
for organization in client.v2.organizations:
for space in organization.spaces(): # perform a GET on spaces_url attribute
organization_reloaded = space.organization() # perform a GET on organization_url attribute
- Application object provides more methods such as
-
- instances
- stats
- start
- stop
- summary
As instance, you can get all the summaries as follows:
Or else:
for app in client.v2.apps:
print(app.summary())
Available managers
So far the implemented managers that are available are:
service_plansservice_plan_visibilitiesservice_instancesservice_keysservice_bindingsservice_brokersappseventsbuildpacksorganizationsspacesservicesroutesshared_domainsprivate_domainssecurity_groups
Note that even if, while navigating, you reach an entity manager that does not exist, the get will be performed and you will get the expected entities. For example, event entity manager is not yet implemented but you can do
for app in client.v2.apps:
for event in app.events():
handle_event_object()
All managers provide the following methods:
list(**kwargs): return an iterator on entities, according to the given filtered parametersget_first(**kwargs): return the first matching entity according to the given parameters. Returns`Noneif none returnedget: perform a GET on the entity. If the entity cannot be find it will raise an exception due to http NOT FOUND response status__iter__: iteration on the manager itself. Alias for a no-filter list__getitem__: alias for thegetoperation_create: the create operation. Since it is a generic operation (only takes a dict object), this operation is protected_update: the update operation. Since it is a generic operation (only takes a the resource id and a dict object), this operation is protected_remove: the delete operation. This operation is maintained protected.
# Assume you have an organization named `test-org` with a guid of `test-org-guid`
org_get = client.v2.organizations.get('test-org-guid')
org_get_first = client.v2.organizations.get_first(**{'name': 'test-org'})
org_from_list = list(client.v2.organizations.list(**{'name': 'test-org'}))[0]
assert org_get == org_get_first == org_from_list
# You can also specify multiple values for a query parameter.
for organization in client.v2.organizations.list(**{'name': ['org1', 'org2']}):
print(organization['metadata']['guid'])
# Order and Paging parameters are also supported.
query = {
'order-by': 'name',
'order-direction': 'desc',
'results-per-page': 100
}
for organization in client.v2.organizations.list(**query):
print(organization['entity']['name'])
API V3
Entities
Entities returned by API V3 calls transcripts links by providing a call on the object with the name of the link itself. Let's explain it with the next code
for app in client.v3.apps.list(space_guids='space_guid'):
for task in app.tasks():
print('Task %s' % task['guid'])
app.stop()
space = app.space()
Another example:
app = client.v3.apps['app-guid']
for task in app.tasks():
task.cancel()
for task in client.v3.tasks.list(app_guids=['app-guid-1', 'app-guid-2']):
task.cancel()
When supported by the API, parent entities can be included in a single call. The included entities replace the links mentioned above. The following code snippet issues three requests to the API in order to get app, space and organization data:
app = client.v3.apps.get("app-guid")
print("App name: %s" % app["name"])
space = app.space()
print("Space name: %s" % space["name"])
org = space.organization()
print("Org name: %s" % org["name"])
By changing the first line only, a single request fetches all the data. The navigation from app to space and space to organization remains unchanged.
app = client.v3.apps.get("app-guid", include="space.organization")
Available managers on API V3 are:
appsbuildpacksdomainsfeature_flagsisolation_segmentsjobsorganizationsorganization_quotasprocessesservice_brokersservice_credential_bindingsservice_instancesservice_offeringsservice_plansspacestasks
The managers provide the same methods as the V2 managers with the following differences:
get(**kwargs): supports keyword arguments that are passed on to the API, e.g. "include"
Networking
policy server
At the moment we have only the network policies implemented
for policy in client.network.v1.external.policies.list():
print('destination protocol = {}'.format(policy['destination']['protocol']))
print('destination from port = {}'.format(policy['destination']['ports']['start']))
print('destination to port = {}'.format(policy['destination']['ports']['end']))
Available managers on API V3 are:
policy
This manager provides:
list(**kwargs): return an iterator on entities, according to the given filtered parameters__iter__: iteration on the manager itself. Alias for a no-filter list_create: the create operation. Since it is a generic operation (only takes a dict object), this operation is protected_remove: the delete operation. This operation is maintained protected.
Application logs
Recent logs of an application can be get as follows:
app = client.v2.apps['app-guid']
for log in app.recent_logs():
print(log)
Logs can also be streamed using a websocket as follows:
app = client.v2.apps['app-guid']
for log in app.stream_logs():
# read message infinitely (use break to exit... it will close the underlying websocket)
print(log)
# or
for log in client.doppler.stream_logs('app-guid'):
# read message infinitely (use break to exit... it will close the underlying websocket)
print(log)
Logs can also be streamed directly from RLP Gateway:
import asyncio
from cloudfoundry_client.client import CloudFoundryClient
target_endpoint = 'https://somewhere.org'
proxy = dict(http=os.environ.get('HTTP_PROXY', ''), https=os.environ.get('HTTPS_PROXY', ''))
rlp_client = CloudFoundryClient(target_endpoint, client_id='client_id', client_secret='client_secret', verify=False)
# init with client credentials
rlp_client.init_with_client_credentials()
async def get_logs_for_app(rlp_client, app_guid):
async for log in rlp_client.rlpgateway.stream_logs(app_guid,
params={'counter': '', 'gauge': ''},
headers={'User-Agent': 'cf-python-client'})):
print(log)
loop = asyncio.get_event_loop()
loop.create_task(get_logs_for_app(rlp_client, "app_guid"))
loop.run_forever()
loop.close()
Command Line Interface
The client comes with a command line interface. Run cloudfoundry-client command. At first execution, it will ask you information about the target platform and your credential (do not worry they are not saved). After that you may have a help by running cloudfoundry-client -h
Operations (experimental)
For now the only operation that is implemented is the push one.
from cloudfoundry_client.operations.push.push import PushOperation
operation = PushOperation(client)
operation.push(client.v2.spaces.get_first(name='My Space')['metadata']['guid'], path)
Issues and contributions
Please submit issue/pull request.
You can run tests by doing so. In the project directory:
$ export PYTHONPATH=main
$ python -m unittest discover test
# or even
$ python setup.py test
5 Apr 28, 2022
4 Nov 16, 2022
1 Jan 24, 2022
2 Sep 2, 2022
0 Oct 5, 2021
2 Nov 23, 2021
8 Dec 26, 2022
12 Oct 27, 2022
5 Aug 7, 2022
11 Nov 5, 2022
2 Feb 10, 2022
10 Jul 9, 2022
4 Feb 11, 2022
2 Nov 4, 2021
1 Feb 24, 2022
1 Nov 21, 2021
4 Mar 18, 2022
2 Dec 5, 2021
1 Dec 31, 2021