Skip to content

Commit

Permalink
Update docs for 0.37.0 release
Browse files Browse the repository at this point in the history
See galasa-dev/projectmanagement#1991

Signed-off-by: James Taylor <jamest@uk.ibm.com>
  • Loading branch information
jt-nti committed Sep 18, 2024
1 parent ce89f71 commit 8ed628c
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 14 deletions.
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
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
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In order to run the Galasa SimBanks tests you need to add some configuration inf

The SimBank tests are held in the <a href="https://github.com/galasa-dev/simplatform" target="_blank"> Galasa simplatform repository</a> in GitHub. To start running the tests you need to clone the repository, if you have not already done so. To find out how to clone the cli repository, follow the instruction in the [Running Galasa SimBank online](../running-simbank-tests/simbank-cli) documentation.

After cloning the repository, complete the following steps to run the SimBankIVT test that is provided with Galasa. The following example uses SimBank OBR version `0.25.0` and Galasa uber OBR version `0.36.0`.
After cloning the repository, complete the following steps to run the SimBankIVT test that is provided with Galasa. The following example uses SimBank OBR version `0.25.0` and Galasa uber OBR version `0.37.0`.

You can find the version of the `dev.galasa.simbank.obr` that you are using by looking in the `pom.xml` file in the `dev.galasa.simbank.obr` folder. The `dev.galasa.uber.obr` is the OBR that contains all the bundles that are needed for Galasa to work including Managers, any required dependencies, the framework, etc. The version of the `dev.galasa.uber.obr` depends on which version of Galasa you have installed.

Expand Down
10 changes: 5 additions & 5 deletions src/markdown-pages/docs/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ Galasa releases 0.35.0 and earlier support the use of Gradle versions 6.8.x, 6.9

To use Gradle version 8.0 or later to create Galasa projects and build and compile Galasa test code, complete the following steps:

1. Edit the `build.gradle` file in the OBR directory of your parent project, setting the plug-in values at the top of the file to version `0.36.0`, as shown in the following example:
1. Edit the `build.gradle` file in the OBR directory of your parent project, setting the plug-in values at the top of the file to version `0.37.0`, as shown in the following example:
```
plugins {
...
id 'dev.galasa.obr' version '0.36.0'
id 'dev.galasa.testcatalog' version '0.36.0'
id 'dev.galasa.obr' version '0.37.0'
id 'dev.galasa.testcatalog' version '0.37.0'
...
}
```
Expand All @@ -51,11 +51,11 @@ tasks.withType(PublishToMavenLocal) { task ->
task.dependsOn mergetestcat
}
```
3. In each test project `build.gradle` file, set the `dev.galasa.tests` plug-in to version `0.36.0` to ensure that the build uses the correct plug-in.
3. In each test project `build.gradle` file, set the `dev.galasa.tests` plug-in to version `0.37.0` to ensure that the build uses the correct plug-in.
```
plugins {
...
id 'dev.galasa.tests' version '0.36.0'
id 'dev.galasa.tests' version '0.37.0'
...
}
```
Expand Down
11 changes: 10 additions & 1 deletion src/markdown-pages/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,15 @@ We have the following available Slack channels:
Access the Galasa source code in [GitHub](https://github.com/galasa-dev) and open issues in the [project management repository](https://github.com/galasa-dev/projectmanagement).


## 0.36.0 - Release Highlights
## 0.37.0 - Release Highlights

- Galasa now supports Java 17.

- You can delete a test run by using the `galasactl runs delete` command. Deleting a test run removes all information about the test run along with any associated artifacts from an ecosystem's RAS.


<details>
<summary><b>0.36.0 - Release Highlights</b></summary>

- You can now create Galasa projects and build and compile Galasa test code using Gradle version 8. For more information, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](docs/upgrading) documentation to understand the changes you need to make.

Expand All @@ -31,6 +39,7 @@ Access the Galasa source code in [GitHub](https://github.com/galasa-dev) and ope
- Various defect fixes

- Various documentation updates
</details>


<details>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const IndexPage = () => (
Learn more
</Button>
<Button target={"/releases"} flash={true} isPrimary={true}>
0.36.0 highlights
0.37.0 highlights
</Button>
</div>
</div>
Expand Down

0 comments on commit 8ed628c

Please sign in to comment.