Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

このコンテンツは選択した言語では利用できません。

Chapter 10. Using Cluster Loader

10.1. What Cluster Loader Does
リンクのコピー

Cluster Loader is a tool that deploys large numbers of various objects to a cluster, which creates user-defined cluster objects. Build, configure, and run Cluster Loader to measure performance metrics of your OpenShift Container Platform deployment at various cluster states.

10.2. Installing Cluster Loader
リンクのコピー

Cluster Loader is included in the atomic-openshift-tests package. To install it, run: 

$ yum install atomic-openshift-tests
Copy to Clipboard Toggle word wrap

After installation, the test executable extended.test is located in /usr/libexec/atomic-openshift/extended.test.

10.3. Running Cluster Loader
リンクのコピー

  1. Set the KUBECONFIG variable to the location of the administrator kubeconfig: 

    $ export KUBECONFIG=${KUBECONFIG-$HOME/.kube/config}
    Copy to Clipboard Toggle word wrap

  2. Execute Cluster Loader using the built-in test configuration, which deploys five template builds and waits for them to complete: 

    $ cd /usr/libexec/atomic-openshift/
$ ./extended.test --ginkgo.focus="Load cluster"
    Copy to Clipboard Toggle word wrap

    Alternatively, execute Cluster Loader with a user-defined configuration by adding the flag for --viper-config: 

    $ ./extended.test --ginkgo.focus="Load cluster" --viper-config=config/test
    1
    Copy to Clipboard Toggle word wrap
    1
    In this example, there is a subdirectory called config/ with a configuration file called test.yml. In the command line, exclude the extension of the configuration file, as the tool will automatically determine the file type and extension.

10.4. Configuring Cluster Loader
リンクのコピー

Create multiple namespaces (projects), which contain multiple templates or pods.

Locate the configuration files for Cluster Loader in the config/ subdirectory. The pod files and template files referenced in these configuration examples are found in the content/ subdirectory.

10.4.1. Configuration Fields
リンクのコピー

Expand
Table 10.1. Top-level Cluster Loader Fields
FieldDescription

cleanup

Set to true or false. One definition per configuration. If set to true, cleanup will delete all namespaces (projects) created by Cluster Loader at the end of the test.

projects

A sub-object with one or many definition(s). Under projects, each namespace to create is defined and projects has several mandatory subheadings.

tuningSet

A sub-object with one definition per configuration. TuningSet allows the user to define a tuning set to add configurable timing to project or object creation (pods, templates, etc).

Expand
Table 10.2. Fields under projects
FieldDescription

number

An integer. One definition of the count of how many projects to create.

basename

A string. One definition of the base name for the project. The count of identical namespaces will be appended to Basename to prevent collisions.

tuning

A string. One definition of what tuning set you want to apply to the objects, which you deploy inside this namespace.

ifexists

A string containing either reuse or delete. Defines what the tool does if it finds a project or namespace that has the same name of the project or namespace it creates during execution.

configmaps

A list of key-value pairs. The key is the ConfigMap name and the value is a path to a file from which you create the ConfigMap.

secrets

A list of key-value pairs. The key is the secret name and the value is a path to a file from which you create the secret.

pods

A sub-object with one or many definition(s) of pods to deploy.

templates

A sub-object with one or many definition(s) of templates to deploy.

Expand
Table 10.3. Fields under pods and templates
FieldDescription

total

This field is not used.

number

An integer. The number of pods or templates to deploy.

image

A string. The docker image URL to a repository where it can be pulled.

basename

A string. One definition of the base name for the template (or pod) that you want to create.

file

A string. The path to a local file, which is either a PodSpec or template to be created.

parameters

Key-value pairs. Under parameters, you can specify a list of values to override in the pod or template.

Expand
Table 10.4. Fields under tuningset
FieldDescription

name

A string. The name of the tuning set which will match the name specified when defining a tuning in a project.

pods

A sub-object identifying the tuningset that will apply to pods.

templates

A sub-object identifying the tuningset that will apply to templates.

Expand
Table 10.5. Fields under tuningset pods or tuningset templates
FieldDescription

stepping

A sub-object. A stepping configuration used if you want to create an object in a step creation pattern.

rate_limit

A sub-object. A rate-limiting tuning set configuration to limit the object creation rate.

Expand
Table 10.6. Fields under tuningset pods or tuningset templates, stepping
FieldDescription

stepsize

An integer. How many objects to create before pausing object creation.

pause

An integer. How many seconds to pause after creating the number of objects defined in stepsize.

timeout

An integer. How many seconds to wait before failure if the object creation is not successful.

delay

An integer. How many milliseconds (ms) to wait between creation requests

10.4.2. Example Cluster Loader Configuration File
リンクのコピー

Cluster Loader’s configuration file is a basic YAML file: 

provider: local
1 

ClusterLoader:
  cleanup: true
  projects:
    - num: 1
      basename: clusterloader-cakephp-mysql
      tuning: default
      ifexists: reuse
      templates:
        - num: 1
          file: ./examples/quickstarts/cakephp-mysql.json

    - num: 1
      basename: clusterloader-dancer-mysql
      tuning: default
      ifexists: reuse
      templates:
        - num: 1
          file: ./examples/quickstarts/dancer-mysql.json

    - num: 1
      basename: clusterloader-django-postgresql
      tuning: default
      ifexists: reuse
      templates:
        - num: 1
          file: ./examples/quickstarts/django-postgresql.json

    - num: 1
      basename: clusterloader-nodejs-mongodb
      tuning: default
      ifexists: reuse
      templates:
        - num: 1
          file: ./examples/quickstarts/nodejs-mongodb.json

    - num: 1
      basename: clusterloader-rails-postgresql
      tuning: default
      templates:
        - num: 1
          file: ./examples/quickstarts/rails-postgresql.json

  tuningset:
2 

    - name: default
      pods:
        stepping:
3 

          stepsize: 5
          pause: 0 s
        rate_limit:
4 

          delay: 0 ms
Copy to Clipboard Toggle word wrap
1
Optional setting for end-to-end tests. Set to local to avoid extra log messages.
2
The tuning sets allow rate limiting and stepping, the ability to create several batches of pods while pausing in between sets. Cluster Loader monitors completion of the previous step before continuing.
3
Stepping will pause for M seconds after each N objects are created.
4
Rate limiting will wait M milliseconds between the creation of objects.

10.5. Known Issues
リンクのコピー

If the IDENTIFIER parameter is not defined in user templates, template creation fails with error: unknown parameter name "IDENTIFIER". If you deploy templates, add this parameter to your template to avoid this error: 

{
  "name": "IDENTIFIER",
  "description": "Number to append to the name of resources",
  "value": "1"
}
Copy to Clipboard Toggle word wrap

If you deploy pods, adding the parameter is unnecessary.

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat