Skip to content

Update documentation #245

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 2, 2023
Merged

Update documentation #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8973be5
Update tested HyperCore version to include v9.2.13
justinc1 May 18, 2023
c638ab8
Document how to setup infrastructure for github CI
justinc1 May 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,29 @@ sc_config:
...
```

## CI jobs for integration tests

Github CI jobs require some infrastructure:
- Dedicated github runner(s), with access to test HyperCore cluster(s).
- We test against multiple HyperCore versions (9.1, 9.2 etc.).
- Test HyperCore clusters
- Currently, a single physical HyperCore cluster is used (https://10.5.11.50).
- It runs two VSNS VMs (virtual single node systems) - for versions 9.1 (https://10.5.11.200) and 9.2 (https://10.5.11.201).
- Each VSNS VM was prepared manually (how - ask Dave), VM was shutdown and we use it as base VM image.
Base VM was cloned to obtain final VSNS VM.
- A docker image for CI jobs, with needed tools preinstalled (ansible-core, jq, and other utilities).
- File [build.sh](ci-infra/docker-image/build.sh) is used to build and push docker image.
- Docker image is built manually, on local workstation.
- Only authenticated users can publish new image - docker-login is required before `docker push`.
- Anyone can download built image. Do not include sensitive data into the image.
- Configured github secrets.
- In many cases, password is stored in github secrets, but corresponding username is not

Some tests need additional infrastructure
- SMB server for testing VM import/export
- NTP server for testing NTP configuration
- OIDC client and test username/password to test OIDC login.

# Development

Included `Makefile` contains shortcuts for common development tasks,
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ but this is not granted.

This collection requires Python 3.8 or greater.

## HyperCore cluster API version compatibility
## HyperCore cluster version compatibility

This collection has been tested against HyperCore cluster API version v9.1.14.208456.
This collection has been tested against following HyperCore cluster versions:
- v9.1.14.208456
- v9.2.13.211102

## Included content

Expand Down