Skip to content

kartoza/GeoHosting

Repository files navigation

GeoHosting

image

GeoHosting website.

Environment:

PROXY_BASE_URL=

The base url of proxy url of Kartoza. Default: https://api.do.kartoza.com/

PROXY_API_KEY=

The API Key of proxy. The proxy is being used for calling jenkins. We need to make sure the proxy has permission with job/build on jenkins.

GeoHosting Controller - Client

This is a python library that will be installed as middleware for create, update or delete application to jenkins.

Environment:

GEOHOSTING_CONTROLLER_SERVER_URL=

This is the url of GeoHosting controller server

GEOHOSTING_CONTROLLER_SERVER_TOKEN=

This is the token that can be generated on GeoHosting controller server.

Functions

Create instance

To create instance:

from geohosting_controller_client.activity import create
activity = create(<package-id>, <subdomain>, <user_email>)

package-id : is the selected package id on the jenkins to create the instance.
subdomain : is the subdomain for the instance.
user_email : is the user email that calling the create.

activity returns the activity detail from server. For this state, save the activity.id to database so it can be checked in future.

To get the detail of activity, can be checked in below step.

Check server activity

from geohosting_controller_client.activity import get_activity_detail
activity = get_activity_detail(<activity_id>)