Skip to content

Commit

Permalink
Improve example subject claims link
Browse files Browse the repository at this point in the history
  • Loading branch information
geofflamrock authored Oct 31, 2023
1 parent c8889f6 commit 20d161d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To login using OIDC:

- Create a [service account](https://oc.to/ServiceAccount) in Octopus with the permissions required. Note that OIDC is only support for service accounts, not user accounts.
- Configure an OIDC identity for the service account that matches the GitHub Actions subject claim for your repository and workflow. See the [Octopus OIDC documentation](https://oc.to/ServiceAccountOidcIdentities) for more information.
- Examples of the subject claims can be found in the [GitHub documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#defining-trust-conditions-on-cloud-roles-using-oidc-claims).
- See [example subject claims](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) for more information on the way that subject strings are generated by GitHub Actions.
- Copy the `Service Account Id` value from the Octopus service account. This will be a GUID.
- Configure your workflow job to have the `id-token: write` permissions. This allows the `OctopusDeploy/login` action to request an ID token from GitHub as part of the OIDC login process.
- Add the `OctopusDeploy/login` action to your workflow, specifying the `server` and `service_account_id` inputs.
Expand Down

0 comments on commit 20d161d

Please sign in to comment.