Skip to main content

A set of xRally plugins to run workloads against Kubernetes platform.

Project description


xRally plugins for Kubernetes platform.

Getting started

First of all, you need to create rally env for Kubernetes. There are two main ways to communicate to Kubernetes cluster - specifying auth-token or certifications. Choose what is suitable for your case and use one of the following samples.

To create env using certifications, use spec samples/platforms/cert-spec.yaml:

rally env create --name kubernetes --spec samples/platforms/cert-spec.yaml

For using Kubernetes token authentication, you need to get API key and use samples/platforms/apikey-spec.yaml spec to create env:

rally env create --name kubernetes --spec samples/platforms/apikey-spec.yaml

For initialization Rally environment to communicate to existing Kubernetes cluster you can also use system environment variables instead of making specification json/yaml file. See the list of available options:

  • As like regular kubernetes client (kubectl) Rally can read kubeconfig file. Call rally env create --name kubernetes-created --from-sys-env and Rally with check $HOME/.kube/config file to the available configuration. Also, you can specify KUBECONFIG variable with a path different to the default $HOME/.kube/config.

  • Despite the fact that kubectl doesn't support specifying Kubernetes credentials via separated system environment variables per separate option (auth_url, api_key, etc) like other platforms support (OpenStack, Docker, etc), Rally team provides this way. Check existing@kubernetes plugin documentation for the list of all available variables. Here is a simple example of this feature:

    # the URL to the Kubernetes host.
    export KUBERNETES_HOST="" 
    #  a path to a file containing TLS certificate to use when connecting to the Kubernetes host.
    export KUBERNETES_CERT_AUTH="~/.kube/cert_auth_file"
    # client API key to use as token when connecting to the Kubernetes host.
    export KUBERNETES_API_KEY="foo"
    # client API key prefix to use in token when connecting to the Kubernetes host.
    # finally create a Rally environment
    rally env create --name my-kubernetes --from-sysenv

Check env availbility by the following command:

rally env check

Where the tasks and bugs are tracked ?!

The primary tracking system is Issues at GitHub.

For Rally framework related issues look at Launchpad.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xrally-kubernetes, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size xrally_kubernetes-1.1.1-py2.py3-none-any.whl (43.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size xrally-kubernetes-1.1.1.tar.gz (56.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page