Skip to content
This repository was archived by the owner on Jun 19, 2025. It is now read-only.

[Do not merge until RMS released] Release management docs #469

Draft
wants to merge 34 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
0256e60
Minimal restructure to demo Concept/How To/Reference/Tutorial approach
MadelineAu Feb 5, 2025
f7c9d9a
fixed redirects and urls
wesfloyd Feb 5, 2025
bd627ef
Addressing review comments
MadelineAu Feb 6, 2025
feae197
Merge branch 'devRestruture' of github.com:MadelineAu/eigenlayer-docs…
MadelineAu Feb 6, 2025
96bbf96
Added redirects
MadelineAu Feb 6, 2025
5264329
fixed redirects
MadelineAu Feb 6, 2025
4e5b0bd
more redirect fixing
MadelineAu Feb 6, 2025
8bff2ec
Merge branch 'MadelineAu-devRestruture'
MadelineAu Feb 6, 2025
9f63380
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 9, 2025
af864c0
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 10, 2025
c49b0e8
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 10, 2025
7e430a0
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 17, 2025
0e1a6eb
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 18, 2025
3ed0774
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 19, 2025
8130497
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 21, 2025
37281a6
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 21, 2025
cf76167
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 21, 2025
6126940
Merge remote-tracking branch 'upstream/main'
MadelineAu Feb 23, 2025
34fad65
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 3, 2025
e8465ae
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 4, 2025
d5ab33c
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 5, 2025
18f4927
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 5, 2025
cbaee98
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 6, 2025
549d047
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 10, 2025
cd0e391
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 13, 2025
c8e803b
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 18, 2025
a6f98f5
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 24, 2025
3b96134
Merge remote-tracking branch 'upstream/main'
MadelineAu Mar 26, 2025
302897a
Merge remote-tracking branch 'upstream/main'
MadelineAu Apr 1, 2025
b8088f9
Merge remote-tracking branch 'upstream/main'
MadelineAu Apr 3, 2025
a6db476
Merge remote-tracking branch 'upstream/main'
MadelineAu Apr 4, 2025
e29e2bb
Merge remote-tracking branch 'upstream/main'
MadelineAu Apr 7, 2025
7182a4a
Added release management docs
MadelineAu Apr 8, 2025
2ace39d
Updated for review feedback
MadelineAu Apr 9, 2025
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
2 changes: 1 addition & 1 deletion docs/developers/Concepts/avs-keys.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
title: AVS Keys
---

Expand Down
16 changes: 16 additions & 0 deletions docs/developers/Concepts/avs-release-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 5
title: AVS Release Management
---

The Release Management Service (RMS) enables verifiable container image signing using Ethereum keys and supports
OpenContainerInterface (OCI) compliant signature publishing to GitHub Container Registry (GHCR). The RMS is an optional
service that enables:

* AVS developers to tag and sign releases.
* Operators to view the latest releases they are registered to run.
* Operators to verify the signature of the release container.

For information on:
* Signing and publishing AVS releases, refer to [Release AVS](../HowTo/publish/release-avs.md).
* Get and verify releases, refer to [Get and Verify AVS Releases](../../operators/howto/get-and-verify-releases.md).
2 changes: 1 addition & 1 deletion docs/developers/Concepts/avs-security-models.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
title: AVS Security Models
---

Expand Down
77 changes: 77 additions & 0 deletions docs/developers/HowTo/publish/release-avs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
sidebar_position: 1
title: Release AVS
---

To sign a release and update the AVS metadata to enable Operators to verify the container was signed by the specified public key
using the [Release Management Service (RMS)](../../Concepts/avs-release-management.md):

1. Add valid keys for container signatures to AVS metadata. The format is:

```
{
"name": "AVS Release Nofitication Demo",
...
"releaseKeys": [
"0xc877a87254ad39e717d2f322192f2b93e3aea5b651e13267901a4f6db507243e"
],
...
}
```

2. Sign the container digest with a key included in the AVS metadata. Using the EigenLayer CLI:

`eigenlayer-cli container sign [options]` with
* `container-digest` - Digest of the container
* `repository-location` - GitHub Container Registry (GHCR) repository location with which to tag the signature artifact.

3. Update the AVS metadata to include the software section with the container name, description, and location.

For AVSs using Operator Sets, the format is:

```
{
"name": "AVS Release Nofitication Demo",
...
"releaseKeys": [
"0xc877a87254ad39e717d2f322192f2b93e3aea5b651e13267901a4f6db507243e"
],
"operatorSets": [
{
"name":"AVS Release Management Demo!!!",
...
"software":[
{
"name": "AVS Application Container",
"description": "A container located in GHCR for node operators to run.",
"location": "ghcr.io/bdchatham/avs-release-demo-v1"
}
],
...
}
]
}
```

For AVSs using AVSDirectory, the format is:

```
{
"name": "AVS Release Nofitication Demo",
"avs_contract_address": "0x4c68f7bef3e14b47ba9af64acb3f0ea70c6535b1",
...
"description": "An AVS using for demonstrating application release tracking & notifications.",
"software": {
"name": "AVS Application Container for M2 Quorum operators.",
"description": "A container located in GHCR for node operators to run.",
"location": "ghcr.io/bdchatham/avs-m2-release-demo"
},
...
}
```

## List Release Keys

To list AVS keys for signing releases included in the AVS metadata, use:

`eigenlayer-cli service list-avs-release-keys –avs-address <address>`
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 8
title: Implement Security Best Practices
---

Expand Down
20 changes: 20 additions & 0 deletions docs/operators/howto/get-and-verify-releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_position: 7
title: Get and Verify AVS Releases
---

If an AVS is using the [Release Management Service (RMS)](../../developers/Concepts/avs-release-management.md), Operators can list and verify the releases they are registered to run.

## List AVS Releases

To list the AVS releases a specified Operator is registered to run, use the EigenLayer CLI:

`eigenlayer-cli service list-operator-releases –operater-address <address>`

## Verify AVS Releases

To verify the container was signed by a public key specified in the AVS metadata, use the EigenLayer CLI:

`eigenlayer-cli container verify [options]` with
* `container-digest` - Digest of the container
* `repository-location` - Github Container Registry (GHCR) repository location from which the release container was obtained.
2 changes: 1 addition & 1 deletion docs/operators/howto/operator-content-guidelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 8
title: Follow Webapp Content Guidelines
---

Expand Down
2 changes: 1 addition & 1 deletion docs/operators/howto/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 9
title: Troubleshoot
---

Expand Down