The purpose of this Ansible automation is to help gain insight into the footprint and start times of MicroShift. At this stage, we are capturing the first start, the second start (with cached images), disk usage data from a number of points in time as well as performance data for each of the two starts.
We are using Prometheus, process-exporter and cAdvisor to capture a wide array of performance tool data.
It is necessary to have two hosts configured for running the benchmarks:
- Ansible server used to start the automation scripts
- MicroShift server used to execute the performance tests
Run the following command on the Ansible server to install the Ansible package.
sudo dnf install -y ansible
There are a few variables that may need user configuration and they are found in vars/all.yml.
| Variable Name | Description | Default |
|---|---|---|
manage_subscription |
Use subscription-manager to entitle host and attach to pool | false |
rhel_username |
Red Hat subscription account username (string) | null |
rhel_password |
Red Hat subscription account password (string) | null |
rhel_pool_id |
Red Hat subscription pool id (string) | null |
manage_repos |
Enable necessary repos to build MicroShift and install necessary components | false |
setup_microshift_host |
Complete initial setup of MicroShift host (subscription, packages, firewall, etc) | false |
prometheus_logging |
Set up logging and exporters on the nodes | true |
install_microshift |
Build and install MicroShift from git | false |
build_etcd_binary |
Build and deploy a separate etcd process | false |
There are a few places to configure before execution.
As with any Ansible playbook, the first file to configure is the inventory located at inventory/inventory.
Sample Inventory File
[microshift]
microshift-dev ansible_host=microshift-dev private_ip=
[microshift:vars]
ansible_user=microshift
[logging]
localhost ansible_connection=local
The user needs to configure the MicroShift host name or IP address to match their environment.
If the configured user on the node is not
microshift, it should be changed as well.
The next location for configuration will be the global variables file located at vars/all.yml.
If the user has a fresh RHEL host to be used for running MicroShift performance benchmarks, the scripts can manage the initial host setup and configuration in addition to the performance capture.
As we can read from the following configuration, we have selected to manage_subscription and this requires the subsequent rhel_* vars to be set.
The other initial configuration steps are toggled with the setup_microshift_host variable, which we have set to true for this configuration.
On a clean system, the playbook will also copy the user-provided pull-secret from roles/install-microshift/files/pull-secret.txt to the correct location on the host.
Sample vars/all.yml File
manage_subscription: true
rhel_username: <subscription manager username>
rhel_password: <subscription manager password>
rhel_pool_id: <subscription manager pool-id>
manage_repos: true
setup_microshift_host: true
prometheus_logging: true
install_microshift: true
build_etcd_binary: false
If the user has an existing host used as the MicroShift development environment, the scripts can be run without the initial configuration steps.
Such host can be created using the instructions from the MicroShift Development Environment on RHEL 8 document.
The manage_subscription and setup_microshift_host variables have been set to false.
Sample vars/all.yml File
manage_subscription: false
rhel_username:
rhel_password:
rhel_pool_id:
manage_repos: true
setup_microshift_host: false
prometheus_logging: true
install_microshift: true
build_etcd_binary: false
If the user has deployed a RHEL4Edge image built with MicroShift, the scripts can be run with a few more variables disabled as the host is fully configured out of the box.
Such host can be created using the instructions from the Install MicroShift on RHEL for Edge document.
The manage_subscription, manage_repos, setup_microshift_host and install_microshift variables have been set to false.
Sample vars/all.yml File
manage_subscription: false
rhel_username:
rhel_password:
rhel_pool_id:
manage_repos: true
setup_microshift_host: false
prometheus_logging: true
install_microshift: false
build_etcd_binary: false
Once the inventory has been edited and the vars/all.yml have been configured, we can now run the playbook.
time ansible-playbook -v -i inventory/inventory run-perf.yml
The following text files be created on the local system running the playbook:
- The
boot.txtwill have the time that it took the microshift service to start and for all the pods to enter theRunningstate - The
disk0.txt, disk1.txt, disk2.txtfiles will have a snapshot of the disk usage at different stages of installation and execution.
If Prometheus was enabled, the performance metrics will be uploaded to the Ansible server, where the user can view all the captured performance data using the http:https://<ansible-server-ip>:9090 URL.