Skip to content

Commit ac39690

Browse files
author
Jill Grant
authored
Update howto-run-instance-readiness-testing.md
Acrolinx fixes
1 parent ce18825 commit ac39690

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

articles/operator-nexus/howto-run-instance-readiness-testing.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ ms.custom: template-how-to, devx-track-azurecli
1313

1414
Instance Readiness Testing (IRT) is a framework built to orchestrate real-world workloads for testing of the Azure Operator Nexus Platform.
1515

16-
## Environment Requirements
16+
## Environment requirements
1717

18-
1. A Linux environment (Ubuntu suggested) capable of calling Azure APIs
19-
1. Knowledge of networks to use for the test
18+
- A Linux environment (Ubuntu suggested) capable of calling Azure APIs
19+
- Knowledge of networks to use for the test
2020
* Networks to use for the test are specified in a "networks-blueprint.yml" file, see [Input Configuration](#input-configuration).
21-
1. curl or wget to download IRT package
21+
- curl or wget to download IRT package
2222

2323
## Before execution
2424

25-
1. From your Linux environment, download nexus-irt.tar.gz from aka.ms/nexus-irt `curl -Lo nexus-irt.tar.gz aka.ms/nexus-irt`
26-
1. Extract the tarball to the local file system: `mkdir -p irt && tar xf nexus-irt.tar.gz --directory ./irt`
27-
1. Switch to the new directory `cd irt`
28-
1. The `setup.sh` script is provided to aid in the initial set up an environment.
25+
1. From your Linux environment, download nexus-irt.tar.gz from aka.ms/nexus-irt `curl -Lo nexus-irt.tar.gz aka.ms/nexus-irt`.
26+
1. Extract the tarball to the local file system: `mkdir -p irt && tar xf nexus-irt.tar.gz --directory ./irt`.
27+
1. Switch to the new directory `cd irt`.
28+
1. The `setup.sh` script is provided to aid in the initial set up of an environment.
2929
* `setup.sh` assumes a nonroot user and attempts to use `sudo`, which installs:
3030
1. `jq` version 1.6
3131
1. `yq` version 4.33
@@ -34,33 +34,33 @@ Instance Readiness Testing (IRT) is a framework built to orchestrate real-world
3434
1. `elinks` for viewing html files on the command line
3535
1. `tree` for viewing directory structures
3636
1. `moreutils` utilities for viewing progress from the ACI container
37-
1. [Optional] Set up a storage account to archive test results over time. For help, see the [instructions](#uploading-results-to-your-own-archive)
38-
1. Log into Azure, if not already logged in: `az login --use-device`
37+
1. [Optional] Set up a storage account to archive test results over time. For help, see the [instructions](#uploading-results-to-your-own-archive).
38+
1. Log into Azure, if not already logged in: `az login --use-device`.
3939
* User should have `Contributor` role
4040
1. Create an Azure Managed Identity for the container to use.
4141
* Using the provided script: `MI_RESOURCE_GROUP="<your resource group> MI_NAME="<managed identity name>" SUBSCRIPTION="<subscription>" ./create-managed-identity.sh`
4242
* Can be created manually via the Azure portal, refer to the script for needed permissions
4343
1. Create a service principal and security group. The service principal is used as the executor of the test. The group informs the kubernetes cluster of valid users. The service principal must be a part of the security group, so it has the ability to log into the cluster.
44-
* You can provide your own, or use our provided script, here's an example of how it could be executed; `AAD_GROUP_NAME=external-test-aad-group-8 SERVICE_PRINCIPAL_NAME=external-test-sp-8 ./irt/create-service-principal.sh`
44+
* You can provide your own, or use our provided script, here's an example of how it could be executed; `AAD_GROUP_NAME=external-test-aad-group-8 SERVICE_PRINCIPAL_NAME=external-test-sp-8 ./irt/create-service-principal.sh`.
4545
* This script prints four key/value pairs for you to include in your input file.
4646
1. If necessary, create the isolation domains required to execute the tests. They aren't lifecycled as part of this test scenario.
47-
* **Note:** if deploying isolation domains, your network blueprint must define at least one external network per isolation domain. see `networks-blueprint.example.yml` for help with configuring your network blueprint.
47+
* **Note:** If deploying isolation domains, your network blueprint must define at least one external network per isolation domain. see `networks-blueprint.example.yml` for help with configuring your network blueprint.
4848
* `create-l3-isolation-domains.sh` takes one parameter, a path to your networks blueprint file; here's an example of the script being invoked:
4949
* `create-l3-isolation-domains.sh ./networks-blueprint.yml`
5050

5151
### Input configuration
5252

53-
1. Build your input file. The IRT tarball provides `irt-input.example.yml` as an example. These values **will not work for all instances**, they need to be manually changed and the file also needs to be renamed to `irt-input.yml`
54-
1. define the values of networks-blueprint input, an example of this file is given in networks-blueprint.example.yml
53+
1. Build your input file. The IRT tarball provides `irt-input.example.yml` as an example. These values **will not work for all instances**, they need to be manually changed and the file also needs to be renamed to `irt-input.yml`.
54+
1. define the values of networks-blueprint input, an example of this file is given in networks-blueprint.example.yml.
5555

5656
The network blueprint input schema for IRT is defined in the networks-blueprint.example.yml. Currently IRT has the following network requirements. The networks are created as part of the test, provide network details that aren't in use.
5757

58-
1. Three(3) L3 Networks
58+
1. Three (3) L3 Networks
5959

6060
* Two of them with MTU 1500
61-
* one of them with MTU 9000 and shouldn't have fabric_asn definition
61+
* One of them with MTU 9000 and shouldn't have fabric_asn definition
6262

63-
1. One(1) Trunked Network
63+
1. One (1) Trunked Network
6464
1. All vlans should be greater than 500
6565

6666
## Execution
@@ -72,7 +72,7 @@ The network blueprint input schema for IRT is defined in the networks-blueprint.
7272

7373
1. A file named `summary-<cluster_name>-<timestamp>.html` is downloaded at the end of the run and contains the testing results. It can be viewed:
7474
1. From any browser
75-
1. using elinks or lynx to view from the command line; for example:
75+
1. Using elinks or lynx to view from the command line; for example:
7676
1. `elinks summary-<cluster_name>-<timestamp>..html`
7777
1. When an SAS Token is provided for the `PUBLISH_RESULTS_TO` parameter the results are uploaded to the blob container you specified. It can be previewed by navigating to the link presented to you at the end of the IRT run.
7878

@@ -84,5 +84,5 @@ The network blueprint input schema for IRT is defined in the networks-blueprint.
8484
1. SUBSCRIPTION
8585
1. STORAGE_ACCOUNT_NAME
8686
1. STORAGE_CONTAINER_NAME
87-
1. Copy the last output from the script, into your IRT YAML input. The output looks like this;
87+
1. Copy the last output from the script, into your IRT YAML input. The output looks like this:
8888
* `PUBLISH_RESULTS_TO="<sas-token>"`

0 commit comments

Comments
 (0)