Skip to content

Commit

Permalink
Updating Github Pages branch with latest Master changes
Browse files Browse the repository at this point in the history
  • Loading branch information
armada-admin committed Jan 26, 2024
1 parent 7972b47 commit ba319a7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
18 changes: 18 additions & 0 deletions developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,24 @@ External Debug Port Mappings:
|jobservice |localhost:4008|
## GoLand Run Configurations
We provide a number of run configurations within the `.run` directory of this project. These will be accessible when opening the project in GoLand, allowing you to run Armada in both standard and debug mode.
The following high-level configurations are provided, each composed of sub-configurations:
1. `Armada Infrastructure Services`
- Runs Infrastructure Services required to run Armada, irrespective of scheduler type
2. `Armada (Legacy Scheduler)`
- Runs Armada with the Legacy Scheduler
3. `Armada (Pulsar Scheduler)`
- Runs Armada with the Pulsar Scheduler (recommended)
4. `LookoutV2 UI`
- Script which configures a local UI development setup
A minimal local Armada setup using these configurations would be `Armada Infrastructure Services` and one of (`Armada (Legacy Scheduler)` or `Armada (Pulsar Scheduler)`). Running the `LookoutV2 UI` script on top of this configuration would allow you to develop the Lookout UI live from GoLand, and see the changes visible in your browser. **These configurations (executor specifically) require a kubernetes config in `$PROJECT_DIR$/.kube/internal/config`**
GoLand does not allow us to specify an ordering for services within docker compose configurations. As a result, some database migration services may require rerunning.
### Other Debugging Methods
Run `mage debug local` to only spin up the dependencies of Armada, and then run the individual components yourself.
Expand Down
11 changes: 10 additions & 1 deletion developer/ubuntu-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,16 @@ Warning: do not install Docker as provided by the `docker.io` and other packages
packages repository - the version of Docker they provide is out-of-date.

Instead, follow the instructions for installing Docker on Ubuntu at https://docs.docker.com/engine/install/ubuntu/ .
Specifically, follow the listed steps for installing using an apt repository, and install the latest Docker version.
Specifically, follow the listed steps for installing using an apt repository, and install a recent version.

*WARNING*: at the time of this writing, there is a known release of the Docker Engine that causes Armada
localdev setups to fail, due to container image loading errors. The broken release is
`5:25.0.0-1~ubuntu.22.04~jammy` (for Ubuntu 22.04) - it may be referenced as Docker Engine v25.0.0. The
most recent prior major version at this time - v24.0.7 - has been verified to work correctly for Armada
development - `5:24.0.7-1~ubuntu.22.04~jammy`. In the docs sub-section *2.0 Install the Docker pages*, click
on the *Specific version* tab for details and instructions how to install an earlier release. However,
it's expected that Docker will have a newer version (higher than 25.0.0) that will fix this issue; please
consult the Docker release notes.

### Relocate Docker storage directory to secondary volume

Expand Down

0 comments on commit ba319a7

Please sign in to comment.