Since Version: 1.0
What is a connector?
A connector is a component which connects to an external service via an API and can exechange data with such a service.
In PIPEFORCE, connectors are implemented using Commands. So, a Command can be in a role of a connector.
There are many such built-in connectors. Some examples:
http.*: This set of commands can connect to any HTTP/S endpoint.
sftp.*: This set of commands can connect to any SFTP endpoint.
iam.*: This set of commands can connect to the internal identity and access management system.
drive.*: This set of commands can connect to the internal data room.
microsoft.teams.send: This command can send messages to a teams channel.
- And many more. See the commands reference for a list of all available commands.
The HTTP/S connectors can be used to connect to HTTP/S endpoints. For example if you would like to make RESTful calls.
Typically such endpoints are secured with username and password or a token. You should never place such sensitive data into your source code. Instead, create a new Secret and refer to it in your pipeline.
Here is an example to access the GitHub API using the command
http.get and a custom secret, created before:
This will return a JSON document like this example, which can be used in the pipeline for further processing:
The SFTP connectors can be used to connect to a SFTP service.
Here is an example to use the
sftp.list command in a pipeline:
Report an Issue
In case you're missing something on this page, you found an error or you have an idea for improvement, please click here to create a new issue. Another way to contribute is, to click Edit this page below and directly add your changes in GitHub. Many thanks for your contribution in order to improve PIPEFORCE!