Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update main for 0.37.0 release #829

Merged
merged 12 commits into from
Sep 19, 2024
2 changes: 2 additions & 0 deletions src/data/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@
path: /docs/manage-ecosystem/cli-runs-get
- title: Downloading test artifacts
path: /docs/manage-ecosystem/ecosystem-cli-runs-download
- title: Deleting test run results
path: /docs/manage-ecosystem/cli-runs-delete
- title: Upgrading
path: /docs/upgrading
- title: Managers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following section explains more about the software prerequisites that you ne

### Java JDK

Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.
Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 21 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.


### Maven
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Local runs do not benefit from the features that are provided when running tests

To use the `galasactl runs submit local` command, the `JAVA_HOME` environment variable must be set to reference the JVM in which you want the test to run, as described in the [CLI prerequisites online](/docs/cli-command-reference/cli-prereqs) and [CLI prerequisites offline](/docs/cli-command-reference/zipped-prerequisites) documentation. This is because the local java run-time environment is used to launch the test locally. To check that `JAVA_HOME` is set correctly, the tool checks that `$JAVA_HOME/bin/java` exists in Unix or Mac, and `%JAVA_HOME%\bin\java.exe` exists on Windows.

The level of Java must match the supported level of the Galasa version that is being launched. Use the `galasactl --version` command to find the galasactl tool version. We currently support Java version 11 to version 16 JDK. _Note:_ We do not currently support Java 17 or later.
The level of Java must match the supported level of the Galasa version that is being launched. Use the `galasactl --version` command to find the galasactl tool version. We currently support Java version 11 to version 17 JDK. _Note:_ We do not currently support Java 21 or later.

You can view the full list of options that are available with the `galasactl runs submit local` command in the
<a href="https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl_runs_submit_local.md" target="_blank">Galasa cli repository</a>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following section explains more about the software prerequisites that you ne

### Java JDK

Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.
Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 21 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.

### Gradle

Expand Down
10 changes: 5 additions & 5 deletions src/markdown-pages/docs/ecosystem/ecosystem-installing-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Complete the following steps to install a Galasa Ecosystem by using Helm:
helm repo add galasa https://galasa-dev.github.io/helm
```
- If the repository exists, run the ```helm repo update``` command to get the latest versions of the packages and then run ```helm search repo galasa``` to see the available charts.<br>
_Note:_ The Galasa Ecosystem Helm chart deploys three persistent volumes (PVs). If you need to provide a Kubernetes storage class for these PVs, download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.36.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file and update the `storageClass` value in the file with the name of a valid storage class on your cluster. If you are deploying to minikube, you can optionally use the standard storage class that is created for you by minikube, but this is not required.
1. Download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.36.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file if you have not done so already, and edit the values of the following properties:
_Note:_ The Galasa Ecosystem Helm chart deploys three persistent volumes (PVs). If you need to provide a Kubernetes storage class for these PVs, download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.37.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file and update the `storageClass` value in the file with the name of a valid storage class on your cluster. If you are deploying to minikube, you can optionally use the standard storage class that is created for you by minikube, but this is not required.
1. Download the <a href=https://github.com/galasa-dev/helm/blob/ecosystem-0.37.0/charts/ecosystem/values.yaml target="_blank"> values.yaml</a> file if you have not done so already, and edit the values of the following properties:
- Set `galasaVersion` to the version of Galasa that you want to run. (See the [Releases](/releases) documentation for released versions). To ensure that each pod in the Ecosystem is running at the same level, do not use `latest` as the Galasa version.
- Set `externalHostname` to the DNS hostname or IP address of the Kubernetes node that is used to access the Galasa Ecosystem services. If you are deploying to minikube, the cluster's IP address can be retrieved by running `minikube ip`.

Expand Down Expand Up @@ -225,22 +225,22 @@ You can then deploy your Galasa tests to a Maven repository and set up a test st
## Upgrading the Galasa Ecosystem


Get the latest version of the Ecosystem chart and upgrade the Galasa Ecosystem to use the newer version of Galasa - for example version 0.36.0 - by running the following command:
Get the latest version of the Ecosystem chart and upgrade the Galasa Ecosystem to use the newer version of Galasa - for example version 0.37.0 - by running the following command:

On Mac or Unix:

```console
helm repo update \
helm upgrade <release-name> galasa/ecosystem --reuse-values \
--set galasaVersion=0.36.0 --wait
--set galasaVersion=0.37.0 --wait
```

On Windows (Powershell):

```console
helm repo update `
helm upgrade <release-name> galasa/ecosystem --reuse-values `
--set galasaVersion=0.36.0 --wait
--set galasaVersion=0.37.0 --wait
```

where:<br>
Expand Down
28 changes: 28 additions & 0 deletions src/markdown-pages/docs/manage-ecosystem/runs-delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
path: "/docs/manage-ecosystem/cli-runs-delete"
title: "Deleting test run results"
---

Over time, test run results build up and take up space in the Galasa Ecosystem. You can delete test runs which have completed in the past by using the `galasactl runs delete` command.

You can view the full command syntax in the <a href="https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl_runs_delete.md" target="_blank">Galasa cli repository</a>.

## Working with the `galasactl runs delete` command

The following example deletes a test run called _C1234_:

```
galasactl runs delete --name C1234 --bootstrap http://example.com:30960/bootstrap
```

## Identifying test runs to delete

Use the `galasactl runs get` command to find the names of the test runs to delete. For example, use the `--age` option to specify a time period in which the tests ran.

```
galasactl runs get --age 6w:1w --bootstrap http://example.com:30960/bootstrap
```

The `--format raw` option is useful if you are writing a script to delete multiple test runs.

You can view the full command syntax for `galasactl runs get` in the <a href="https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl_runs_get.md" target="_blank">Galasa cli repository</a>.
22 changes: 11 additions & 11 deletions src/markdown-pages/docs/manage-ecosystem/runs-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ The following example command returns test status in a summary format for tests
On Mac or Unix:

```
galasactl runs get --bootstrap http://example.com:30960/boostrap \
galasactl runs get --bootstrap http://example.com:30960/bootstrap \
--requestor bobsmith --age 2w:1w
```

On Windows (Powershell):

```
galasactl runs get --bootstrap http://example.com:30960/boostrap `
galasactl runs get --bootstrap http://example.com:30960/bootstrap `
--requestor bobsmith --age 2w:1w
```

Expand All @@ -80,7 +80,7 @@ On Windows (Powershell):
Results are returned on the terminal in the following example format:

```
$galasactl runs get --bootstrap http://example.com:30960/boostrap \
$galasactl runs get --bootstrap http://example.com:30960/bootstrap \
--requestor bobsmith --age 2w:1w --format summary

submitted-time(UTC) name status result test-name
Expand All @@ -103,13 +103,13 @@ The following example command returns test status in a details format:
On Mac or Unix:

```
$galasactl runs get --name U456 --bootstrap http://example.com:30960/boostrap \
$galasactl runs get --name U456 --bootstrap http://example.com:30960/bootstrap \
--format details
```

On Windows (Powershell):
```
galasactl runs get --name U456 --bootstrap http://example.com:30960/boostrap `
galasactl runs get --name U456 --bootstrap http://example.com:30960/bootstrap `
--format details
```

Expand All @@ -122,7 +122,7 @@ where:
Results are returned on the terminal in the following example format:

```
$galasactl runs get --name U456 --format details --bootstrap http://example.com:30960/boostrap
$galasactl runs get --name U456 --format details --bootstrap http://example.com:30960/bootstrap
name : U456
status : finished
result : Passed
Expand Down Expand Up @@ -150,13 +150,13 @@ The following example command returns test status in a raw format:
On Mac or Unix:

```
galasactl runs get --name U456 --bootstrap http://example.com:30960/boostrap \
galasactl runs get --name U456 --bootstrap http://example.com:30960/bootstrap \
--format raw
```

On Windows (Powershell):
```
galasactl runs get --name U456 --bootstrap http://example.com:30960/boostrap `
galasactl runs get --name U456 --bootstrap http://example.com:30960/bootstrap `
--format raw
```

Expand All @@ -181,19 +181,19 @@ On Mac or Unix:

```
galasactl runs get --age 1d --result failed,envfail \
--bootstrap http://example.com:30960/boostrap
--bootstrap http://example.com:30960/bootstrap
```

On Windows (Powershell):
```
galasactl runs get --age 1d --result failed,envfail `
--bootstrap http://example.com:30960/boostrap
--bootstrap http://example.com:30960/bootstrap
```

Results are returned on the terminal in the following example format:

```
galasactl runs get --age 1d --result failed,envfail --bootstrap http://example.com:30960/boostrap
galasactl runs get --age 1d --result failed,envfail --bootstrap http://example.com:30960/bootstrap

submitted-time(UTC) name status result test-name
2023-05-05 10:55:29 U456 ending Failed MyTestName1
Expand Down
26 changes: 13 additions & 13 deletions src/markdown-pages/docs/manage-ecosystem/runs-prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ path: "/docs/manage-ecosystem/ecosystem-cli-runs-prepare"
title: "Selecting tests to run in an Ecosystem"
---

If you have a group of tests that you want to run in batch, the simplest way to do this is by defining these tests inside a portfolio. You can create a portfolio of tests by using the `runs prepare` command. You can build the portfolio from single or multiple [test streams](https://galasa.dev/docs/writing-own-tests/test-streams).
If you have a group of tests that you want to run in batch, the simplest way to do this is by defining these tests inside a portfolio. You can create a portfolio of tests by using the `runs prepare` command. You can build the portfolio from single or multiple [test streams](/docs/manage-ecosystem/test-streams).

This portfolio of tests can then be run by using the [runs submit command](/docs/manage-ecosystem/ecosystem-cli-runs-submit). When you submit the tests to run, you need specify only the portfolio name on the command, rather than listing all of the classes.

Expand All @@ -20,7 +20,7 @@ On Mac or Unix:

```
galasactl runs prepare \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--stream BestSoFar \
--package dev.galasa.simbank.tests
Expand All @@ -30,7 +30,7 @@ On Windows (Powershell):

```
galasactl runs prepare `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--stream BestSoFar `
--package dev.galasa.simbank.tests
Expand All @@ -46,7 +46,7 @@ On Mac or Unix:

```
galasactl runs prepare \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--stream BestSoFar \
--package dev.galasa.simbank.tests,dev.galasa.example.banking
Expand All @@ -56,7 +56,7 @@ On Windows (Powershell):

```
galasactl runs prepare `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--stream BestSoFar `
--package dev.galasa.simbank.tests,dev.galasa.example.banking
Expand All @@ -72,7 +72,7 @@ On Mac or Unix:

```
galasactl runs prepare \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--class dev.galasa.simbank.tests/SimBankIVT \
--class dev.galasa.simbank.tests/BasicAccountCreditTest
Expand All @@ -82,7 +82,7 @@ On Windows (Powershell):

```
galasactl runs prepare `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--class dev.galasa.simbank.tests/SimBankIVT `
--class dev.galasa.simbank.tests/BasicAccountCreditTest
Expand All @@ -101,7 +101,7 @@ On Mac or Unix:

```
galasactl runs prepare \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--stream BestSoFar \
--package dev.galasa.simbank.tests \
Expand All @@ -113,7 +113,7 @@ On Windows (Powershell):

```
galasactl runs prepare `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--stream BestSoFar `
--package dev.galasa.simbank.tests `
Expand All @@ -134,14 +134,14 @@ On Mac or Unix:

```
galasactl runs prepare \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--stream BestSoFar \
--package dev.galasa.simbank.tests \
--override zos.default.lpar=MYLPAR \
--override zos.default.cluster=MYPLEX \
galasactl runs prepare \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--append \
--stream BestSoFar \
Expand All @@ -154,14 +154,14 @@ On Windows (Powershell):

```
galasactl runs prepare `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--stream BestSoFar `
--package dev.galasa.simbank.tests `
--override zos.default.lpar=MYLPAR `
--override zos.default.cluster=MYPLEX `
galasactl runs prepare `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--append `
--stream BestSoFar `
Expand Down
8 changes: 4 additions & 4 deletions src/markdown-pages/docs/manage-ecosystem/runs-submit.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ On Mac or Unix:

```
galasactl runs submit \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--portfolio my_portfolio.yaml \
--poll 5 \
--progress 1 \
Expand All @@ -31,7 +31,7 @@ On Windows (Powershell):

```
galasactl runs submit `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--portfolio my_portfolio.yaml `
--poll 5 `
--progress 1 `
Expand All @@ -58,7 +58,7 @@ On Mac or Unix:

```
galasactl runs submit \
--bootstrap http://example.com:30960/boostrap \
--bootstrap http://example.com:30960/bootstrap \
--class dev.galasa.simbank.tests/SimBankIVT \
--class dev.galasa.simbank.tests/BasicAccountCreditTest \
--stream BestSoFar \
Expand All @@ -69,7 +69,7 @@ On Windows (Powershell):

```
galasactl runs submit `
--bootstrap http://example.com:30960/boostrap `
--bootstrap http://example.com:30960/bootstrap `
--class dev.galasa.simbank.tests/SimBankIVT `
--class dev.galasa.simbank.tests/BasicAccountCreditTest `
--stream BestSoFar `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ The following are properties used to configure the Galasa Ecosystem Manager.
| Required: | No |
| Default value: | None |
| Valid values: | Valid URL |
| Examples: | <code>galasaecosystem.isolated.mvp.zip=https://github.com/galasa-dev/isolated/releases/download/v0.36.0/galasa-isolated-mvp-0.36.0.zip</code> |
| Examples: | <code>galasaecosystem.isolated.mvp.zip=https://github.com/galasa-dev/isolated/releases/download/v0.37.0/galasa-isolated-mvp-0.37.0.zip</code> |

</details>

Expand Down
Loading
Loading