Skip to content

Commit

Permalink
update install guides for automated testing
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonrandrews committed Jan 16, 2024
1 parent da14141 commit e2e5daf
Show file tree
Hide file tree
Showing 14 changed files with 56 additions and 69 deletions.
10 changes: 4 additions & 6 deletions content/install-guides/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@
additional_search_terms:
- linux
- deploy


author_primary: Jason Andrews
layout: installtoolsall
minutes_to_complete: 10
author_primary: Jason Andrews
multi_install: false
multitool_install_part: false
official_docs: https://docs.ansible.com/ansible/latest/index.html
test_images:
- ubuntu:latest
test_link: null
test_maintenance: false
title: Ansible
author_primary: Jason Andrews
tool_install: true
weight: 1
---
Expand Down Expand Up @@ -49,7 +47,7 @@ The easiest way to install the latest version of Ansible for Ubuntu on Arm is to

To enable the PPA and install Ansible run the commands:

```bash { target="ubuntu:latest" }
```bash
sudo apt update
sudo apt install software-properties-common -y
sudo add-apt-repository --yes --update ppa:ansible/ansible
Expand All @@ -58,7 +56,7 @@ sudo apt install ansible -y

Confirm the Ansible command line tools are installed by running:

```bash { target="ubuntu:latest" }
```bash
ansible-playbook --version
```

Expand Down
4 changes: 2 additions & 2 deletions content/install-guides/armclang.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ official_docs: https://developer.arm.com/documentation/100748
test_images:
- ubuntu:latest
- fedora:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_maintenance: true
test_link: null
test_maintenance: false
test_status:
- passed
- passed
Expand Down
4 changes: 2 additions & 2 deletions content/install-guides/aws-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ multitool_install_part: false
official_docs: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html
test_images:
- ubuntu:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_maintenance: true
test_link: null
test_maintenance: false
test_status:
- passed
title: AWS CLI
Expand Down
9 changes: 4 additions & 5 deletions content/install-guides/azure-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
additional_search_terms:
- cloud
- azure
-
author_primary: Jason Andrews
layout: installtoolsall
minutes_to_complete: 15
author_primary: Jason Andrews
multi_install: false
multitool_install_part: false
official_docs: https://learn.microsoft.com/en-us/cli/azure
test_images:
- ubuntu:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_link: null
test_maintenance: true
test_status:
- passed
Expand All @@ -34,7 +33,7 @@ This article provides a quick solution to install Azure CLI for Ubuntu on Arm.

Confirm you are using an Arm machine by running:

```bash
```bash { target="ubuntu:latest" }
uname -m
```

Expand Down Expand Up @@ -69,4 +68,4 @@ source $HOME/.profile
az version
```

After a successful log in, you can use the [Azure CLI](../azure-cli) and automation tools like [Terraform](../terraform) from the terminal.
After a successful log in, you can use the [Azure CLI](../azure-cli) and automation tools like [Terraform](../terraform) from the terminal.
9 changes: 4 additions & 5 deletions content/install-guides/eksctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
additional_search_terms:
- kubernetes
- EKS
- AWS
- AWS
- infrastructure

author_primary: Jason Andrews
layout: installtoolsall
minutes_to_complete: 5
author_primary: Jason Andrews
multi_install: false
multitool_install_part: false
official_docs: https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html
test_images:
- ubuntu:latest

test_link: null
test_maintenance: true
test_status:
- passed
Expand All @@ -34,7 +33,7 @@ This install guide provides a quick solution to install `eksctl` on Arm Linux an

For Linux, confirm you are using an Arm machine by running:

```bash
```bash { target="ubuntu:latest" }
uname -m
```

Expand Down
71 changes: 33 additions & 38 deletions content/install-guides/forge.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,25 @@
---
### Title the install tools article with the name of the tool to be installed
### Include vendor name where appropriate
title: Linaro Forge

### Optional additional search terms (one per line) to assist in finding the article
additional_search_terms:
- forge
- ddt
- map
- performance reports
- allinea

### Estimated completion time in minutes (please use integer multiple of 5)
minutes_to_complete: 15

- forge
- ddt
- map
- performance reports
- allinea
author_primary: Florent Lebeau

### Link to official documentation
layout: installtoolsall
minutes_to_complete: 15
multi_install: false
multitool_install_part: false
official_docs: https://www.linaroforge.com/documentation/

### test_automation
test_images:
- ubuntu:latest
test_link: null
test_maintenance: true
test_status:
- passed


### PAGE SETUP
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
tool_install: true # Set to true to be listed in main selection page, else false
multi_install: false # Set to true if first page of multi-page article, else false
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
title: Linaro Forge
tool_install: true
weight: 1
---

[Linaro Forge](https://www.linaroforge.com/) is a server and HPC development tool suite for C, C++, Fortran, and Python high performance code on Linux.
Expand All @@ -57,22 +43,24 @@ Download and extract the appropriate installation package from [Linaro Forge Dow
sudo apt install wget
wget https://downloads.linaroforge.com/23.0/linaro-forge-23.0-linux-aarch64.tar
tar -xf linaro-forge-23.0-linux-aarch64.tar
cd linaro-forge-23.0-linux-aarch64
```

## Installation

### Linux host

Run the installer from the command line with:
```

```console
./textinstall.sh [--accept-license] [install_dir]
```

If no install directory is specified, you will be prompted to specify this while the installer runs.

To install to the default directory, non-interactively:

```bash { target="ubuntu:latest" }
./textinstall.sh --accept-license /home/ubuntu/linaro/forge/23.0
linaro-forge-23.0-linux-aarch64/textinstall.sh --accept-license /home/ubuntu/linaro/forge/23.0
```

### Install on MacOS (remote client only)
Expand Down Expand Up @@ -103,25 +91,27 @@ You should turn off compiler optimizations as they can produce unexpected result

Linaro Forge's debugging tool, Linaro DDT, can be launched with the `ddt` command. For MPI applications, you can prefix the mpirun/mpiexec command normally used to run in parallel:

```bash
```console
ddt mpirun -n 128 myapp
```

This startup method is called *Express Launch* and is the simplest way to get started. If your MPI is not supported by *Express Launch*, you can run the following instead:

```bash
```console
ddt -n 128 myapp
```

These commands will launch Linaro DDT GUI. When running on a HPC cluster, you may need to debug on compute nodes where this may not be possible. In this case, you can start the GUI on the frontend node with the `ddt` command and when running or submitting a job to the compute nodes use `ddt --connect` :

With *Express Launch*:
```bash

```console
ddt --connect mpirun -n 128 myapp
```

Without *Express Launch*:
```bash

```console
ddt --connect -n 128 myapp
```

Expand All @@ -136,17 +126,20 @@ Typically you should keep optimization flags enabled when profiling (rather than
Linaro Forge's profiling tool, Linaro MAP, can be launched with the `map` command to launch the GUI. When running on a HPC cluster with MPI, you should use `map --profile` when running or submitting a job to the compute nodes:

With *Express Launch*:
```bash

```console
map --profile mpirun -n 128 myapp
```

Without *Express Launch*:
```bash

```console
map --profile -n 128 myapp
```

A *.map file will be created in the current directory with profiling results when the application terminates. This file can be then open from the GUI launched on the frontend node or with the following command:
```bash

```console
map myapp_128p_<timestamp>.map
```

Expand All @@ -157,12 +150,14 @@ Linaro Forge's reporting tool Linaro Performance Reports is designed to run on u
Linaro Performance Reports does not use a GUI. Instead, it produces HTML and TXT files when the application terminates to summarize the application behavior. Here is how to use the tool on MPI applications

With *Express Launch*:
```bash

```console
perf-report mpirun -n 128 myapp
```

Without *Express Launch*:
```bash

```console
perf-report -n 128 myapp
```
Two files `myapp_128p_<timestamp>.html` and `myapp_128p_<timestamp>.txt` will be created in the current directory.
Expand Down
2 changes: 1 addition & 1 deletion content/install-guides/gcc/arm-gnu.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ official_docs: https://gcc.gnu.org/onlinedocs/
test_images:
- ubuntu:latest
- fedora:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_link: null
test_maintenance: true
test_status:
- passed
Expand Down
2 changes: 1 addition & 1 deletion content/install-guides/gcc/native.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ official_docs: https://gcc.gnu.org/onlinedocs/
test_images:
- ubuntu:latest
- fedora:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_link: null
test_maintenance: true
test_status:
- passed
Expand Down
3 changes: 1 addition & 2 deletions content/install-guides/gfortran.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ official_docs: https://gcc.gnu.org/onlinedocs/gfortran/
test_images:
- ubuntu:latest
- fedora:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_link: null
test_maintenance: true
test_status:
- passed
- passed
title: GFortran
tool_install: true
weight: 1
Expand Down
2 changes: 1 addition & 1 deletion content/install-guides/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ multitool_install_part: false
official_docs: https://go.dev/doc/
test_images:
- ubuntu:latest
test_maintenance: false
test_maintenance: true
title: Go
tool_install: true
weight: 1
Expand Down
2 changes: 1 addition & 1 deletion content/install-guides/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ multitool_install_part: false
official_docs: https://kubernetes.io/docs/reference/kubectl
test_images:
- ubuntu:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_link: null
test_maintenance: true
test_status:
- passed
Expand Down
4 changes: 1 addition & 3 deletions content/install-guides/nomachine.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ official_docs: https://www.nomachine.com/all-documents
test_images:
- ubuntu:latest
test_link: null
test_maintenance: true
test_status:
- passed
test_maintenance: false
title: NoMachine
tool_install: true
weight: 1
Expand Down
1 change: 0 additions & 1 deletion content/install-guides/oci-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ multitool_install_part: false
official_docs: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm
test_images:
- ubuntu:latest

test_maintenance: true
test_status:
- passed
Expand Down
2 changes: 1 addition & 1 deletion content/install-guides/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ multitool_install_part: false
official_docs: https://developer.hashicorp.com/terraform/docs
test_images:
- ubuntu:latest
test_link: https://github.com/armflorentlebeau/arm-learning-paths/actions/runs/4312122327
test_link: false
test_maintenance: true
test_status:
- passed
Expand Down

0 comments on commit e2e5daf

Please sign in to comment.