Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(security): Add custom spire config env variable #1041

Merged
merged 2 commits into from
Apr 27, 2023
+28 −0
Merged

feat(security): Add custom spire config env variable #1041

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cebdae
feat(security): Add custom spire config env variable
ejlee3 Apr 26, 2023
49f49d5
fix: address pr comments
ejlee3 Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs_src/security/Ch-DelayedStartServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,33 @@ in order to use delayed start services.

## How to Enable (Docker)

### Enable Custom Application or Device Services (Optional)
If using EdgeX with custom Application or Device services in Secure mode, first generate a docker-compose.yml file by running the following command from edgex-compose/compose-builder

```shell
$ make gen delayed-start
```

Open the generated docker-compose.yml file and set the `EDGEX_SPIFFE_CUSTOM_SERVICES` Environment variable.
To set multiple custom services, use a white space delimiter.

```yaml
security-spire-config:
...
environment:
...
EDGEX_SPIFFE_CUSTOM_SERVICES: '<custom-service> <custom-service-2>'
```

Run the modified Docker Compose file

```shell
$ docker compose -p edgex up -d
```

Refer to the [configuration steps below](#configure-and-verify-services) to finish setting up any custom/non-core services.

### Running in Delayed Start Mode
Using the Docker run scripts, start the framework with the `delayed-start` option:

```shell
Expand All @@ -33,6 +60,7 @@ This will cause the following microservices to be started:
* **edgex-security-spire-agent** - local node attestation agent
* **edgex-security-spiffe-token-provider** - EdgeX microservice that exchanges a SPIFFE token for a secret store token

### Configure and Verify Services
Next, pass the following environment variables to any non-core EdgeX microservice
that has SPIFFE/SPIRE support compiled-in:

Expand Down