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.

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

Jump to bottom

Added non-Quattor documentation #178

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added non-Quattor documentation #178

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3aaac31
Added details of non-Quattor installation
Will-Cross1 May 2, 2024
9c94b56
Added more information on certificates
Will-Cross1 May 2, 2024
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
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,31 @@ Grafana dashboards for the IRIS, SCD Cloud, RAL Tier1, and SeaDataCloud accounti
- `/provisioning` - Files that go into `/etc/grafana/provisioning` to define where Grafana can locate dashboard JSON files and what datasources it has access to. Note that the datasources file is a skeleton that would need the url, user and password added.
- `/schemas` - Contains SQL files used to set up and initialise additional databases used by the dashbaords.
- `/scripts` - Contains a utility script and config to apply a fixed colour mapping to all series within a dashboard JSON.

<br>

## Non-Quattor instillation

You first need a VM to work on and an IRIS account.
if you have set up the VM with Grafana properly then there should be a `grafana.ini` file in this path `/etc/grafana`.

Now you need to open the `grafana.ini` config file and make note of the domain which should look like this:
`domain=host-(`Hostname`).nubes.stfc.ac.uk`.

For development a self-signed certificate is useful.
You can create it by running this command:<br>
>`openssl req -x509 -newkey rsa:4096 -keyout hostkey.pem -out hostcert.pem -sha256 -days 180 -nodes -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=CommonNameOrHostname"`<br>

But, this is only for development and a properly issued
certificate is required for production.
Put it in `/etc/grid-security/hostcert.pem` and add your private key to `/etc/grid-security/hostkey.pem`.

Check the configuration of the datasources and set the password in `secrets/apel_db_pwd`. The details for that would come from whoever manages the database your using.

In IRIS Create a new client and give it a name,
for the Redirect URLs you will need the domain from the config file and it will look like this:
- `https://(`domain`):(`port`)/login/generic_oauth`
- `http://(`domain`):(`port`)/login/generic_oauth`

After that you will need to put the Client id you get from the client and put it in `/etc/grafana/secrets/iris_iam_client_id`.
You will also need to put Client secret from the Credentials section of client config into `/etc/grafana/secrets/iris_iam_client_secret`.