Skip to content

Commit ed9b4c9

Browse files
awileysnykgitbook-bot
authored andcommitted
GITBOOK-8461: Change danger callouts to warning
1 parent 88852a4 commit ed9b4c9

File tree

6 files changed

+15
-16
lines changed

6 files changed

+15
-16
lines changed

docs/enterprise-setup/service-accounts/service-accounts-using-oauth-2.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can create an `oauth_client_secret` service account at either the Group or O
1313

1414
The response returns the `client_secret` and the `client_id`. You cannot view the `client_secret` again after the service account is created. If you have misplaced it, you can [rotate](manage-service-accounts-using-the-snyk-api.md#manage-a-service-account-client-secret-for-your-group) your `client_secret` and receive a new one.
1515

16-
{% hint style="danger" %}
16+
{% hint style="warning" %}
1717
Never share the `client_secret` publicly, as this is used to authenticate your service account. Keep it secure and private.
1818
{% endhint %}
1919

docs/enterprise-setup/snyk-broker/install-and-configure-snyk-broker/advanced-configuration-for-helm-chart-installation/insecure-downstream-mode.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,18 @@ description: Usage of this mode is discouraged.
44

55
# Insecure Downstream Mode
66

7-
In some situations, you may need to use only http for your downstream connection. Usually because of historical http only setups, these cases are relatively infrequent, and upgrading them to use https instead is our recommendations.
7+
In some situations, you may need to use only HTTP for your downstream connection. These cases are relatively infrequent and usually occur because of historical http-only setups. Snyk recommends upgrading to use HTTPS instead.
88

9-
In the cases where this is not possible in the near term, the insecure downstream mode introduces a way to force downstream requests to your SCM/JIRA/others to take place over http instead of https.
9+
In the cases where this is not possible in the near term, the insecure downstream mode introduces a way to force downstream requests to your SCM/JIRA/others to take place over HTTP instead of HTTPS.
1010

11-
Using this mode should be avoided in most cases and remains opt-in.\
12-
It makes all requests go over http, therefore not benefiting from the safety of TLS encryption. It means all your credentials and data will appear unencrypted, which is only tolerable in tightly secure networks.
11+
You should avoid using this mode in most cases; it is opt-in. It makes all requests go over HTTP, thus without the benefit of the safety of TLS encryption. This mode means all your credentials and data will appear unencrypted, which is tolerable only in tightly-secured networks.
1312

1413
Use the [Custom additional options for Broker Helm Chart installation](custom-additional-options-for-broker-helm-chart-installation.md) to inject this environment variable:
1514

1615
`--set env[0].name=INSECURE_DOWNSTREAM --set env[0].value="true"`
1716

18-
{% hint style="danger" %}
19-
Using HTTP is highly insecure ! Your data and credentials will transit in clear over the network exchanges.
17+
{% hint style="warning" %}
18+
Using HTTP is highly insecure. Your data and credentials will transit in the clear over the network exchanges.
2019

21-
Snyk **will not be held responsible** for any credential leaks that may occur as a result of the usage this mode.
20+
Snyk **will not be held responsible** for any credential leaks that may occur as a result of the use of HTTP.
2221
{% endhint %}

docs/enterprise-setup/snyk-broker/troubleshooting-broker.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To keep the logs concise in normal operation, Snyk produces minimal information
3030

3131
When you set `LOG_INFO_VERBOSE="true"`, the environment variable will add the headers in these log lines without requiring that you use debug.
3232

33-
{% hint style="danger" %}
33+
{% hint style="warning" %}
3434
If you override the default logging, some logs may be provided by other processes such as API requests, and may list credentials. Before you send any Broker logs with increased logging enabled, check for any passwords or tokens and redact them in bulk.
3535
{% endhint %}
3636

@@ -115,20 +115,20 @@ Open Fix/Upgrade PRs or PR/recurring tests may fail because of fetching big mani
115115

116116
## Troubleshooting Broker with Code Agent
117117

118-
<figure><img src="https://lh3.googleusercontent.com/r_qtONpOOEW35gdyoBcWDAiC6j04M76q8mh922SHor4bdNZdt83sj2kP7d5hbzYcWVXp4Q2hZEiCeAVOmcj4Bu1yFPdnyp3rK7kKeBK8DZEd9S133Xn3YdjddclVf5maEbP23Jor" alt="Snyk Code Analysis workflow with Broker"><figcaption><p>Snyk Code Analysis workflow with Broker</p></figcaption></figure>
118+
<figure><img src="https://lh3.googleusercontent.com/r_qtONpOOEW35gdyoBcWDAiC6j04M76q8mh922SHor4bdNZdt83sj2kP7d5hbzYcWVXp4Q2hZEiCeAVOmcj4Bu1yFPdnyp3rK7kKeBK8DZEd9S133Xn3YdjddclVf5maEbP23Jor" alt="&#x22;&#x22;"><figcaption><p>Snyk Code Analysis workflow with Broker</p></figcaption></figure>
119119

120120
The best way to troubleshoot the Broker with the Code Agent is to understand the communication flow. Traffic travels from Snyk > Broker Client > Code Agent > On-premise Git > Code Agent > Snyk.
121121

122-
The vast majority of problems with the Code aAgent are due to traffic being interrupted at one of these points.
122+
The vast majority of problems with the Code Agent are due to traffic being interrupted at one of these points.
123123

124124
### Troubleshooting the Code Agent
125125

126126
As for Standalone Broker, in order to troubleshoot the code agent, you must generate logs. Do this by attempting to import a repository.
127127

128128
1. Ensure that the Broker is functioning correctly and you can list the repositories. If this does not work, review the Standalone Broker troubleshooting steps.
129-
2. If after attempting to import a repository, you see an error message `Bundle Creation Failed`, review the logs of the containers.
129+
2. If, after attempting to import a repository, you see an error message `Bundle Creation Failed`, review the logs of the containers.
130130
3. Start with the Broker container. Run `docker logs <container id>`
131-
4. Look for the string `snykgit` . This is the API call from the Broker container to the Code Agent container. If you get anything other than a 200 code, there is some problem with the communication between the Broker and the Code Agent. Ensure you have the proper flags set in the docker run command. Also ensure you have set up the docker network
131+
4. Look for the string `snykgit` . This is the API call from the Broker container to the Code Agent container. If you get anything other than a 200 code, there is some problem with the communication between the Broker and the Code Agent. Ensure you have the proper flags set in the docker run command. Also, ensure you have set up the Docker network
132132
5. Review the logs of the Code Agent by running `docker logs <container id>`
133133

134134
### Common problems with the Code Agent

docs/implement-snyk/enterprise-implementation-guide/phase-2-configure-account/configure-snyk-apprisk-integrations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ After you click on the Integration Hub, a list of the available integrations is
4646

4747
Use the Snyk AppRisk Integrations Hub to configure your SCM integrations.&#x20;
4848

49-
{% hint style="danger" %}
49+
{% hint style="warning" %}
5050
Integration Hub is a distinct integration interface dedicated to Snyk AppRisk, separate from the Organization integrations interface.
5151
{% endhint %}
5252

docs/integrate-with-snyk/jira-and-slack-integrations/snyk-security-in-jira-cloud-integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Now, according to your schedule, Jira will search for any issues for which the v
125125

126126
## Uninstall Snyk Security in Jira Cloud
127127

128-
{% hint style="danger" %}
128+
{% hint style="warning" %}
129129
Uninstalling Snyk Security in Jira Cloud will disconnect Snyk vulnerabilities from their associated Jira issues.\
130130
\
131131
To uninstall a Jira app, you must be an administrator in the site-admins, administrators, or jira-administrators groups.

docs/scan-with-snyk/snyk-container/kubernetes-integration/overview-of-kubernetes-integration/how-snyk-controller-handles-your-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ After you install the Snyk Controller in your Kubernetes cluster, it pulls image
2020
* The size of scanning queues
2121
* The network speed.
2222

23-
{% hint style="danger" %}
23+
{% hint style="warning" %}
2424
Snyk highly recommends NOT storing sensitive data in plain text as an environment variable in the container, for example, password, authentication token, and SSH key. Alternatively, you can store the sensitive data in a Secret, mount it as a Volume, and access the information from there.
2525
{% endhint %}

0 commit comments

Comments
 (0)