Skip to content

Commit

Permalink
docs: Show how plugins are loaded (#2801)
Browse files Browse the repository at this point in the history
Signed-off-by: Kostis Kapelonis <[email protected]>
  • Loading branch information
kostis-codefresh authored May 23, 2023
1 parent 6ac1533 commit 2761629
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 1 deletion.
Binary file added docs/contributing-assets/plugin-loading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
6 changes: 6 additions & 0 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ Argo Rollouts plugins depend on hashicorp's [go-plugin](https://github.com/hashi
provides a way for a plugin to be compiled as a standalone executable and then loaded by the rollouts controller at runtime.
This works by having the plugin executable act as a rpc server and the rollouts controller act as a client. The plugin executable
is started by the rollouts controller and is a long-lived process and that the rollouts controller connects to over a unix socket.

Here is an overview of how plugins are loaded:

[![Loading of plugins](contributing-assets/plugin-loading.png)](contributing-assets/plugin-loading.png)


The communication protocol uses golang built in net/rpc library so plugins have to be written in golang.

## Plugin Repository
Expand Down
2 changes: 1 addition & 1 deletion docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

1. To automatically update the stable tag, select `Update stable tag`. (false by default)

[![GitHub Release Action](release-action.png)](release-action.png)
[![GitHub Release Action](contributing-assets/release-action.png)](contributing-assets/release-action.png)

1. When the action completes, visit the generated draft [Github releases](https://github.com/argoproj/argo-rollouts/releases) and enter the details about the release:
* Getting started (copy from previous release and new version)
Expand Down

0 comments on commit 2761629

Please sign in to comment.