Fix broken links #240
Fix broken links #240
Conversation
georgevanburgh
requested review from
sanderson042,
mchurichi,
ajessup,
Andres-GC,
evan2645 and
umairmkhan
as code owners
✅ Deploy Preview for spiffe ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| @@ -63,7 +63,7 @@ Different selectors are available depending on the platform or architecture on w | |||
| | For a list of supported selectors for this platform | Go here | | |||
| | ---------------- | ----------- | | |||
| | **Kubernetes** | The [configuration reference page for the Kubernetes Node Attestor](https://github.com/spiffe/spire/blob/{{< spire-latest "tag" >}}/doc/plugin_server_nodeattestor_k8s_sat.md) | |||
| | **AWS** | The [configuration reference page for the AWS Node Resolver](https://github.com/spiffe/spire/blob/{{< spire-latest "tag" >}}/doc/plugin_server_noderesolver_aws_iid.md) | |||
| | **AWS** | The [configuration reference page for the AWS Node Attestor](https://github.com/spiffe/spire/blob/{{< spire-latest "tag" >}}/doc/plugin_server_nodeattestor_aws_iid.md) | |||
There was a problem hiding this comment.
I believe the node resolver was retired in spiffe/spire#2191, and functionality moved into the node attestor plugin
| @@ -21,7 +21,7 @@ The server will send to the agent a list of all registration entries for workloa | |||
|
|
|||
| During workload attestation, the agent discovers selectors and compares them to those in the cached registration entries to determine which SVIDs they should assign to the workload. | |||
|
|
|||
| You register a workload either by issuing the `spire-server entry create` command at the command line or calling directly into the Registration API, as described in the [Registration API documentation](https://github.com/spiffe/spire/blob/{{< spire-latest "tag" >}}/proto/spire/api/registration/registration.proto). Existing entries can be modified using the `spire-server entry update` command. | |||
| You register a workload either by issuing the `spire-server entry create` command at the command line or calling directly into the Entry API, as described in the [Entry API documentation](https://github.com/spiffe/spire/blob/{{< spire-latest "tag" >}}/proto/spire/api/server/entry/v1/entry.proto). Existing entries can be modified using the `spire-server entry update` command. | |||
There was a problem hiding this comment.
I think that the "registration api" was removed in spiffe/spire#2487, and replaced by the entry api? (@azdagron)
There was a problem hiding this comment.
Yes, that is correct, @mchurichi.
| * [SPIFFE](https://branding.cncf.io/tree/master/projects/spiffe) | ||
| * [SPIRE](https://branding.cncf.io/tree/master/projects/spire) |
There was a problem hiding this comment.
Per the README in cncf/cncf-branding this site has been retired, and now blindly redirects to cncf/artwork. As a result, the paths to the artwork folders need to be "github paths". We could go directly to the github links and cut out the redirect if we wanted? Happy to change this if that is preferred.
There was a problem hiding this comment.
I'd rather go with the github links directly, not that I'm concerned about an extra redirect, but would be better in case that the cncf removes the redirects in the future
| @@ -16,7 +16,7 @@ Secrets managers typically control, audit and securely store sensitive informati | |||
|
|
|||
| A common architectural challenge in deploying secrets managers is how to securely store the credential that is used by the workload to access the secret store itself. This is sometimes called "credential zero", the "bootstrap credential", or more broadly, the process of "secure introduction". | |||
|
|
|||
| By contrast, while SPIRE does _generate_ SPIFFE identities that can be used to [authenticate to other systems](/docs/latest/spire-integrations/use-cases/), SPIRE does not aim to store existing keys (such as a database password) on behalf of a workload. | |||
| By contrast, while SPIRE does _generate_ SPIFFE identities that can be used to [authenticate to other systems](/docs/latest/spire-about/use-cases/), SPIRE does not aim to store existing keys (such as a database password) on behalf of a workload. | |||
There was a problem hiding this comment.
I think this page was just moved in #194, and the alias went one level too deep for this link to work (/docs/latest/spire-integrations/use-cases/use-cases instead of /docs/latest/spire-integrations/use-cases.
Signed-off-by: George Vanburgh <[email protected]>
Signed-off-by: George Vanburgh <[email protected]>
georgevanburgh
force-pushed
the
fix-links
branch
from
40700fa to
2e8d203
Compare
There was a problem hiding this comment.
Thanks for this @georgevanburgh!, and sorry for the delay in getting back to you.
Overall looks great to me, just left two minor comments about the CNCF branding link and the Entry API URL
| * [SPIFFE](https://branding.cncf.io/tree/master/projects/spiffe) | ||
| * [SPIRE](https://branding.cncf.io/tree/master/projects/spire) |
There was a problem hiding this comment.
I'd rather go with the github links directly, not that I'm concerned about an extra redirect, but would be better in case that the cncf removes the redirects in the future
| @@ -16,7 +16,7 @@ Secrets managers typically control, audit and securely store sensitive informati | |||
|
|
|||
| A common architectural challenge in deploying secrets managers is how to securely store the credential that is used by the workload to access the secret store itself. This is sometimes called "credential zero", the "bootstrap credential", or more broadly, the process of "secure introduction". | |||
|
|
|||
| By contrast, while SPIRE does _generate_ SPIFFE identities that can be used to [authenticate to other systems](/docs/latest/spire-integrations/use-cases/), SPIRE does not aim to store existing keys (such as a database password) on behalf of a workload. | |||
| By contrast, while SPIRE does _generate_ SPIFFE identities that can be used to [authenticate to other systems](/docs/latest/spire-about/use-cases/), SPIRE does not aim to store existing keys (such as a database password) on behalf of a workload. | |||
A few more outdated/broken links in the documentation