Skip to content

Commit 1252a92

Browse files
Modify Sonarqube token and add outbound connection details
Updated Sonarqube token variable and added outbound connection requirements.
1 parent 83d7e7e commit 1252a92

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.relay.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Generally the naming works like:
8080
| **GitHub App** | Arg `-s app`, `GITHUB=https://github.com`, `GITHUB_API=https://api.github.com`, `GITHUB_GRAPHQL=https://api.github.com/graphql`, `GITHUB_APP_CLIENT_ID`, `GITHUB_APP_CLIENT_PEM` (either path to PEM or PEM contents), `GITHUB_INSTALLATION_ID` |
8181
| **Prometheus** | `PROMETHEUS_API=http://mycompany.prometheus.internal`, `PROMETHEUS_USERNAME`, `PROMETHEUS_PASSWORD` |
8282
| **Gitlab** | `GITLAB_API=https://gitlab.com`, `GITLAB_TOKEN` |
83-
| **Sonarqube** | `SONARQUBE_API=https://sonarqube.mycompany.com`, `SONARQUBE_TOKEN` |
83+
| **Sonarqube** | `SONARQUBE_API=https://sonarqube.mycompany.com`, `SONAR_TOKEN` |
8484
| **Bitbucket Cloud** | `BITBUCKET_API=https://api.bitbucket.org`, `BITBUCKET_TOKEN` |
8585
| **Bitbucket Hosted** | `BITBUCKET_API=https://bitbucket.mycompany.com`, `BITBUCKET_USERNAME`, `BITBUCKET_PASSWORD` |
8686
| **Jira** | `JIRA_API=https://jira.mycompany.com`, `JIRA_USERNAME`, `JIRA_TOKEN` |
@@ -112,12 +112,12 @@ graph TD
112112
CortexService -->|Github API Calls|SnykBrokerServer
113113
114114
subgraph Cortex-Cloud
115-
CortexService
116-
SnykBrokerServer
115+
CortexService["CortexService<br/>api.getcortexapp.com"]
116+
SnykBrokerServer["SnykBrokerServer<br/>relay.cortex.io"]
117117
end
118118
119119
subgraph Customer-Network
120-
subgraph CortexAxonAgent
120+
subgraph CortexAxonAgent["CortexAxonAgent - ghcr.io"]
121121
SnykBrokerClient
122122
end
123123
InternalGithub
@@ -158,6 +158,18 @@ proxy:
158158
certSecretName: my-proxy-ca-pem # name of the secret containing a .pem file with the CA certificate
159159
```
160160

161+
## Required Outbound Connections
162+
163+
You must allow outbound HTTPS (port 443) to:
164+
165+
| Endpoint | Purpose |
166+
|----------|---------|
167+
| `api.getcortexapp.com` | CortexService - Agent registration and API calls |
168+
| `relay.cortex.io` | SnykBrokerServer - WebSocket tunnel for relayed requests |
169+
| `ghcr.io` | GitHub Container Registry (for pulling the agent image) |
170+
171+
No inbound firewall ports need to be opened - the agent initiates all outbound connections.
172+
161173
## Understanding the Agent configuration
162174

163175
Agent configuration is driven with an `accept.json` file which defines which outbound routes the agent can call in your environment. There are built-in files for all of the supported integrations [here](agent/server/snykbroker/accept_files), but these files are not special, you can always create your own file and pass it with the `-f` flag, for example:
@@ -256,4 +268,4 @@ Which requires:
256268
1. Setting the `PLUGIN_DIRS` environment variable to a directory that contains your plugin files, such as `/plugins`
257269
2. Creating an executable file in that directory `my-plugin`. For each invocation of an outbound request, this plugin will be executed and its `stdout` will be used as the value for the header `my-custom-header-plugin`.
258270

259-
Currently plugins are ONLY supported for `headers`.
271+
Currently plugins are ONLY supported for `headers`.

0 commit comments

Comments
 (0)