docs: fix broken link and add link check #1016
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #1016 +/- ##
==========================================
- Coverage 59.58% 58.38% -1.20%
==========================================
Files 74 92 +18
Lines 4498 5529 +1031
==========================================
+ Hits 2680 3228 +548
- Misses 1573 1987 +414
- Partials 245 314 +69 ☔ View full report in Codecov by Sentry. |
susanshi
commented
Aug 23, 2023
susanshi
changed the title
susanshi
requested review from
akashsinghal,
binbin-li,
jimmyraywv,
luisdlp and
toddysm
as code owners
susanshi
commented
Aug 25, 2023
docs/reference/oras-auth-provider.md
Outdated
| @@ -90,7 +90,7 @@ The official steps for setting up Workload Identity on AKS can be found [here](h | |||
|
|
|||
| Ratify resolves registry credentials from [Docker Config Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets) in the cluster. Ratify considers kubernetes secrets in two ways: | |||
|
|
|||
| 1. The configuration can specify a list of `secrets`. Each entry REQUIRES the `secretName` field. The `namespace` field MUST also be provided if the secret does not exist in the namespace Ratify is deployed in. The Ratify helm chart contains a [roles.yaml](https://github.com/deislabs/ratify/blob/main/charts/ratify/templates/roles.yaml) file with role assignments. If a namespace other than Ratify's namespace is provided in the secret list, the user MUST add a new role binding to the cluster role for that new namespace. | |||
| 1. The configuration can specify a list of `secrets`. Each entry REQUIRES the `secretName` field. The `namespace` field MUST also be provided if the secret does not exist in the namespace Ratify is deployed in. The Ratify helm chart contains a [roles.yaml](https://github.com/deislabs/ratify/blob/main/charts/ratify/templates/??.yaml) file with role assignments. If a namespace other than Ratify's namespace is provided in the secret list, the user MUST add a new role binding to the cluster role for that new namespace. | |||
There was a problem hiding this comment.
@akashsinghal , do you know which roles.yaml this should link to?
There was a problem hiding this comment.
We have both cluster-role and role defined secret access. In terms of this case, I think we can refer to https://github.com/deislabs/ratify/blob/main/charts/ratify/templates/ratify-manager-role-clusterrole.yaml
binbin-li
reviewed
Aug 28, 2023
docs/reference/oras-auth-provider.md
Outdated
| @@ -90,7 +90,7 @@ The official steps for setting up Workload Identity on AKS can be found [here](h | |||
|
|
|||
| Ratify resolves registry credentials from [Docker Config Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets) in the cluster. Ratify considers kubernetes secrets in two ways: | |||
|
|
|||
| 1. The configuration can specify a list of `secrets`. Each entry REQUIRES the `secretName` field. The `namespace` field MUST also be provided if the secret does not exist in the namespace Ratify is deployed in. The Ratify helm chart contains a [roles.yaml](https://github.com/deislabs/ratify/blob/main/charts/ratify/templates/roles.yaml) file with role assignments. If a namespace other than Ratify's namespace is provided in the secret list, the user MUST add a new role binding to the cluster role for that new namespace. | |||
| 1. The configuration can specify a list of `secrets`. Each entry REQUIRES the `secretName` field. The `namespace` field MUST also be provided if the secret does not exist in the namespace Ratify is deployed in. The Ratify helm chart contains a [roles.yaml](https://github.com/deislabs/ratify/blob/main/charts/ratify/templates/??.yaml) file with role assignments. If a namespace other than Ratify's namespace is provided in the secret list, the user MUST add a new role binding to the cluster role for that new namespace. | |||
There was a problem hiding this comment.
We have both cluster-role and role defined secret access. In terms of this case, I think we can refer to https://github.com/deislabs/ratify/blob/main/charts/ratify/templates/ratify-manager-role-clusterrole.yaml
.github/workflows/build-pr.yml
Outdated
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 |
There was a problem hiding this comment.
should we follow the same convention that use digest intead of tag?
|
Hi @binbin-li , thanks for the feedback, i ve pushed an update, please review. |
binbin-li
approved these changes
Aug 29, 2023
bspaans
pushed a commit
to bspaans/ratify
that referenced
this pull request
Oct 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What this PR does / why we need it:
Which issue(s) this PR fix (s) when the PR gets merged)*:
Fixes #984
Type of change
Please delete options that are not relevant.
mainbranch)How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration
Checklist:
Post Merge Requirements
Helm Chart Change