Skip to content

Commit 2d732b7

Browse files
committed
updated secret prefixes
1 parent 255765f commit 2d732b7

3 files changed

Lines changed: 13 additions & 6 deletions

File tree

docs/credentials.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## S3 data server
55

6-
- In general, the credentials you need from your S3 account are the `ACCESS_KEY` and the `SECRET_KEY`. These are akin to user names and passwords.
6+
- In general, the credentials you need from your S3 account are the `AccessKey` and the `SecretKey`. These are akin to user names and passwords.
77
- How you obtain these credentials will depend on your provider (e.g. AWS S3, MINIO, OSN - see below)
88
- Paste the access key and the secret key as _Repository secrets_ in your _FaaSr-workflow_ as per the instructions in the [workflow repo] documentation
99

@@ -32,7 +32,7 @@ In summary:
3232

3333
- You need an API key from your provider to configure for use in FaaSr
3434
- How you obtain this will depend on your cloud provider.
35-
- Paste the API key under the name `OW_API.key` as a _Repository secret_ in your _FaaSr-workflow_ as per the instructions in the [workflow repo] documentation
35+
- Paste the API key under the name `OW_APIkey` as a _Repository secret_ in your _FaaSr-workflow_ as per the instructions in the [workflow repo] documentation
3636

3737

3838
## Google Cloud

docs/defaults.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The following values are set by default in the Web UI and take effect unless ove
3636
- `AWS_AccessKey`: AWS Lambda access key
3737
- `AWS_SecretKey`: AWS Lambda secret key
3838
- `GCP_SecretKey`: GCP secret key
39-
- `OW_API.key`: OpenWhisk API key
39+
- `OW_APIkey`: OpenWhisk API key
4040
- `SLURM_Token`: SLURM JWT token
4141

4242
## Log folder (in S3)

docs/workflow_repo.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@ The simplest way to configure this repository is to fork from the FaaSr organiza
1616
- While you can choose a different name for your fork, here we assume you leave the default _FaaSr-workflow_
1717
- Click on the green _Create fork_ button
1818

19-
The base repository comes with an example workflow used in the [FaaSr tutorial]
19+
The base repository comes with an example workflow used in the [FaaSr tutorial].
20+
21+
## Enabling FaaSr actions
22+
23+
In order to use register and invoke workflows, you also need to perform a one-time configuration to enable running the pre-defined FaaSr register and invoke workflow actions. To do this:
24+
25+
- Click on the _Actions_ tab (top of the GitHub page, next to _Code_ and _Pull requests_)
26+
- Click on the green button _I understand my workflows, please go ahead and enable them_
2027

2128
## Configuring secrets
2229

@@ -35,8 +42,8 @@ Before you can register and invoke workflows, you need to create secrets storing
3542
- When creating a workflow with the [FaaSr Workflow Builder Web UI], you are asked to enter a name for your S3 data server(s)
3643
- The default compute server name for an S3 server is `S3`
3744
- Assume the name of a data server you are setting the secrets for is `S3`, you need two secrets, named exactly as follows (replace `S3` with the name of the server you configured)
38-
- `S3_ACCESS_KEY`
39-
- `S3_SECRET_KEY`
45+
- `S3_AccessKey`
46+
- `S3_SecretKey`
4047
- The secrets you store under these names are the access and secret keys you obtained from your S3 provider
4148

4249
### GitHub Actions

0 commit comments

Comments
 (0)