Skip to content

Commit

Permalink
Document EDG_LOG_FORMAT variable
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Weiße <[email protected]>
  • Loading branch information
daniel-weisse committed Nov 19, 2024
1 parent 516c179 commit 108a74b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/docs/workflows/add-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Adding a service to your application requires three steps, which are described i
## **Step 1:** Get your service ready for MarbleRun

To get your service ready for MarbleRun, you need to rebuild it with one of the supported [runtimes](../features/runtimes.md):

* [EGo](../building-marbles/ego.md)
* [Edgeless RT](https://github.com/edgelesssys/marblerun/blob/master/samples/helloc%2B%2B)
* [Gramine](../building-marbles/gramine.md)
Expand All @@ -29,6 +30,7 @@ Now that your service is ready, you need to make two types of entries in the man
As is described in more detail in the [writing a manifest hands-on](../workflows/define-manifest.md#packages), the manifest contains a section `Packages`, in which allowed enclave software packages are defined.

#### EGo / EdgelessRT

To add an entry for your EGo / EdgelessRT service, run the `oesign` tool on the enclave file you built in the previous step as follows. (`oesign` is installed with [Edgeless RT](https://github.com/edgelesssys/edgelessrt).)

```bash
Expand All @@ -50,7 +52,6 @@ The tool's output is similar to the following.

To add an entry for your Gramine service, run the `gramine-sgx-get-token` tool on the `.sig` file you built in the previous step as follows. (`gramine-sgx-get-token` is installed with [Gramine](https://github.com/gramineproject/gramine/).)


```bash
gramine-sgx-get-token --sig hello.sig
```
Expand Down Expand Up @@ -91,7 +92,6 @@ ProductID (ISVPRODID) : 1
SecurityVersion (ISVSVN) : 3
```


Use `UniqueID` (i.e., `MRENCLAVE` in Intel SGX speak) or the triplet of `SignerID` (i.e., `MRSIGNER`), `SecurityVersion`, and `ProductID` to add an entry in the `Packages` section.

### **Step 2.2:** Define the parameters
Expand Down Expand Up @@ -125,6 +125,8 @@ The environment variables have the following purposes.

* `EDG_MARBLE_DNS_NAMES` is the list of DNS names and IPs the Coordinator will issue the Marble's certificate for.

Optionally, you can set the `EDG_LOG_FORMAT` environment variable to `json` to enable JSON structured logs for the Marble's start up code.

## **Step 4:** Deploy your service with Kubernetes

Typically, you'll write a Kubernetes resource definition for your service, which you'll deploy with the Kubernetes CLI, Helm, or similar tools.
Expand Down

0 comments on commit 108a74b

Please sign in to comment.