Skip to content

Commit b79a9bb

Browse files
Update links and small corrections
1 parent ffe8dfa commit b79a9bb

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,16 @@ config_server = ConfigServer("https://daq-config.diamond.ac.uk")
2323
file_contents = config_server.get_file_contents({ABSOLUTE_PATH_TO_CONFIG_FILE}, desired_return_type=str)
2424

2525
```
26-
The output will come out as a raw string - you should format it as required in your own code. You may also request that the file contents is returned as a `dict` or in `bytes` - this will raise an http exception if the file cannot be converted to that type. To be able to read a file, you must first add it to the whitelist [TODO link to whitelist]
26+
The output will come out as a raw string - you should format it as required in your own code. You may also request that the file contents is returned as a `dict` or in `bytes` - this will raise an http exception if the file cannot be converted to that type. To be able to read a file, you must first add it to the [whitelist](https://github.com/DiamondLightSource/daq-config-server/blob/main/whitelist.yaml).
2727

2828

2929
## Testing and deployment
3030

31+
To run unit tests, type `tox -e unit_tests` from within the dev container
3132

32-
There is a convenient script in `./deployment/build_and_push.sh` which can be used to easily build and run the container locally for testing, and optionally push the container to ghcr. To push to the registry you must first get a github token and login using `podman login ghcr.io --username <your gh login> --password-stdin`
33+
There is a convenient script in `./deployment/build_and_push.sh` which can be used to easily build and run the container locally for testing, and optionally push the container to ghcr. In general we should rely on the CI to be pushing new containers - it should only be done manually for urgent debugging.
3334

34-
To run system tests, you open the repo in a dev container and run `daq-config-server` on one terminal, then `pytest .` in another terminal, from the `/workspaces/daq-config-server` location
35-
36-
[TODO wait for helmchart to be merged in before adding this bit]
35+
To run system tests, start a local container by running `./deployment/build_and_push.sh -r -b`. Then, in the dev container, forward port 8555. There are instructions on port forwarding within vscode [here](https://code.visualstudio.com/docs/debugtest/port-forwarding). Next, in a terminal in the devcontainer, run `pytest .` from the `daq-config-server` directory.
3736

3837
To test on argus, log in to argus in your namespace and run:
3938

docs/explanations/whitelist_info.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ The centrally-hosted config server is running with the same permissions as the `
44

55
This service was designed primarily to read beamline configuration files, like lookup tables and key-value variables. However, as long the file is safe for **anyone** to read, it can be safely added to the whitelist.
66

7-
See the [general guide](../how-to/config-server-guide.md#Adding files to the whitelist) if you need to read sensitive information in your Bluesky plans.
7+
See the [general guide](../how-to/config-server-guide.md) if you need to read sensitive information in your Bluesky plans.

docs/how-to/config-server-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By default, this will return the file's raw string output - which includes thing
1919

2020
# Adding files to the whitelist
2121

22-
For [security reasons](../explanations/whitelist_info.md), only files existing on the whitelist [TODO link to whitelist.yaml] can be read. Please make a PR to add a file to the whitelist. If unsure, please ask in the #daq-config-server slack channel or create a GitHub issue. To make the config-server as quick to use as possible, the server will check any requests against the `whitelist.yaml` file on **the main branch of the repository**, rather than the whitelist in the latest release. The server will check for updates every 5 minutes.
22+
For [security reasons](../explanations/whitelist_info.md), only files existing on the [whitelist](https://github.com/DiamondLightSource/daq-config-server/blob/main/whitelist.yaml) can be read. Please make a PR to add a file to the whitelist. If unsure, please ask in the #daq-config-server slack channel or create a GitHub issue. To make the config-server as quick to use as possible, the server will check any requests against the `whitelist.yaml` file on **the main branch of the repository**, rather than the whitelist in the latest release. The server will check for updates every 5 minutes.
2323

2424
# Reading sensitive information
2525

0 commit comments

Comments
 (0)