Update example plugin #1061
Merged
Update example plugin #1061
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sgnn7
suggested changes
Dec 30, 2019
|
|
||
| To create a new Secretless connector plugin, follow these instructions: | ||
|
|
||
| 1. Copy the relevant template directory (HTTP/TCP) into a folder on your local machine (or to `internal/plugin/connectors/<connector type>` if you are building an internal connector). |
There was a problem hiding this comment.
connector type -> connector_type
|
|
||
| If you're not sure which connector type is appropriate for your target service, please refer to the [connector technical overview](https://github.com/cyberark/secretless-broker/tree/master/pkg/secretless/plugin/connector#technical-overview) for guidelines. | ||
|
|
||
| 1. Update the copied files to implement your connector. Each file includes instructions in the form of TODOs. |
There was a problem hiding this comment.
We should probably surround the TODO with backticks for clarity here
|
|
||
| If you follow the TODO-based instructions included in the files in this directory, you will be able to write integration tests for your connector using `docker-compose`. The included test scripts & files will help you stand up networked containers with docker-compose. | ||
|
|
||
| **Note for internal connectors:** The the test directory should be copied into `test/connector/<connector type>/` and renamed to `<connector_name>`. The [`Jenkinsfile`](../../Jenkinsfile) is set up to automatically run the integration tests from this directory with each project build. |
There was a problem hiding this comment.
The line breaks in this file should probably follow the standard editor line length max (80-100 chars) rather than having it all in single lines.
| @@ -3,6 +3,9 @@ version: '3.0' | |||
| services: | |||
| # TODO: add a service for the platform you want secretless to connect with | |||
|
|
|||
| # TODO: make sure Secretless runs with your plugin | |||
| # which may mean adding the .so file as a volume | |||
| # and revising the command to pass in the .so using the -p flag | |||
There was a problem hiding this comment.
Surround .so with backtics in both lines as well as the -p
test/plugin/example/connector.go
Outdated
| clientConn net.Conn, | ||
| credentialValuesByID connector.CredentialValuesByID, | ||
| ) (net.Conn, error) { | ||
| connector.logger.Debugln("waiting for initial write from client") |
There was a problem hiding this comment.
Given the indentation of the method signature, it might be easier to read with a LF above this line
There was a problem hiding this comment.
Debugln should probably start capitalized (it's not an error message). Same applies to rest of non-error messages.
There was a problem hiding this comment.
will fix, but this was a copy-paste from the old example
test/plugin/example/plugin.go
Outdated
| "pluginAPIVersion": "0.1.0", | ||
| "type": "connector.tcp", | ||
| "id": "example-tcp-connector", | ||
| "description": "it's just an example", |
There was a problem hiding this comment.
Maybe something better/more formal should be used here (eg. Example TCP Plugin)
izgeri
force-pushed
the
update-example-plugin
branch
2 times, most recently
from
b67ea0e
to
c248c50
Compare
added 2 commits
January 2, 2020 13:29
The example plugin should be a better copy of the template (eg use two files, connector.go and plugin.go) so that it's clearer to people trying to build plugins exactly how to create and build them in practice This reorganizes the content to better mimic the templates and updates the Dockerfile to correctly build the plugin.
The connector templates were originally written for internal connectors, but will be used as a guide by people building external connectors. This commit revises the languages in the README to default to an external-connector building audience, but maintains the guidelines for building internal connectors.
izgeri
force-pushed
the
update-example-plugin
branch
from
c248c50
to
53e9b5b
Compare
sgnn7
approved these changes
Jan 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do (include background context, if relevant)?
We're working on updating the docs to advise on how to build external Secretless connector plugins
This PR updates the template / docs to assume that someone is building an external plugin, and revises the example plugin to be better based on the template.
What ticket does this PR close?
Connected to cyberark/secretless-docs#213