Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Adding quick-start example #476

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Adding quick-start example #476

wants to merge 5 commits into from

Conversation

cccsss01
Copy link

@cccsss01 cccsss01 commented Sep 5, 2023

Had issues w/ current readme in spiffe.io, changed the quick-start guide to deploy spiffe/spire.

Signed-off-by: cccsss01 <56396984+cccsss01@users.noreply.github.com>
Signed-off-by: cccsss01 <56396984+cccsss01@users.noreply.github.com>
Signed-off-by: cccsss01 <56396984+cccsss01@users.noreply.github.com>
Copy link
Contributor

@kfox1111 kfox1111 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for contributing this. It looks very helpful. :)

Some comments inline

examples/quick-start/client-deployment.yaml Show resolved Hide resolved
examples/quick-start/README.md Outdated Show resolved Hide resolved

# Obtain the Required Files

This guide requires a number of **.yaml** files. To obtain this directory of files clone **https://github.com/spiffe/spire-tutorials** and obtain the **.yaml** files from the **spire-tutorials/k8s/quickstart-helm** subdirectory. Remember to run all kubectl commands in the directory in which those files reside.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This I think isn't true anymore when in the helm-charts repo?

Comment on lines +54 to +60
In order to enable SPIRE to perform workload attestation -- which allows the agent to identify the workload to attest to its agent -- you must register the workload in the server. This tells SPIRE how to identify the workload and which SPIFFE ID to give it.

1. Create a new registration entry for the node, specifying the SPIFFE ID to allocate to the node:
> **Note** change -selector k8s_sat:cluster:demo-cluster to your cluster name

```shell
$ kubectl exec -n spire spire-server-0 -- \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The controller-manager provided with the chart will automatically do this. Its the recommended way.

In this section, you configure a workload container to access SPIRE. Specifically, you are configuring the workload container to access the Workload API UNIX domain socket.

The **client-deployment.yaml** file configures a no-op container using the **spire-k8s** docker image used for the server and agent. Examine the `volumeMounts` and `volumes configuration` stanzas to see how the UNIX domain `spire-agent.sock` is bound in.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe some comment about the spire-agent with the parameters "api watch" makes it function as a normal workload and not as the spire-agent itself. Otherwise we might confuse the user into thinking they need their own spire-agent in each workload?

@faisal-memon faisal-memon added this to the 0.14.0 milestone Sep 6, 2023
@faisal-memon faisal-memon added the documentation Improvements or additions to documentation label Sep 6, 2023
@marcofranssen marcofranssen changed the title Adding quick-start helm-chart Adding quick-start example Sep 7, 2023
cccsss01 and others added 2 commits September 26, 2023 09:32
Co-authored-by: kfox1111 <Kevin.Fox@pnnl.gov>
Signed-off-by: cccsss01 <56396984+cccsss01@users.noreply.github.com>
Co-authored-by: Faisal Memon <fymemon@yahoo.com>
Signed-off-by: cccsss01 <56396984+cccsss01@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants