-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Nr 324109 updating iast Dec 13 #19529
base: develop
Are you sure you want to change the base?
Conversation
testing connection
Updated the installation procedure for IAST
This reverts commit d8ae25b.
Updated IAST
Dec 13 Changes Done for IAST Installation
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Hi @newrelic707195 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). |
|
src/content/docs/iast/install.mdx
Outdated
|
||
There are primarily five stages involved in successful installation of IAST: | ||
|
||
1. [Safety Check](#safety-check) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Capitalization is not uniform in this list
5. [Restart and test the application](#restart-and-test-the-application) | ||
|
||
<CONTRIBUTOR_NOTE> | ||
I may need to delete the above steps as these steps do not align with our Style guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a comment?
Added new screenshots, updated majorly the support for Go Agent
|
|
||
There are primarily five stages involved in successful installation of IAST: | ||
|
||
1. [Safety check](#safety-check) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not parallel. Fix.
To install New Relic IAST: | ||
|
||
<Steps> | ||
<Step> | ||
Go to <DNT>**[one.newrelic.com](https://one.newrelic.com) > All capabilities > IAST**</DNT> and click <DNT>**Set up IAST with applications**</DNT>. | ||
Go to <DNT>**[one.newrelic.com](https://one.newrelic.com) > All capabilities > IAST** </DNT> and click <DNT>**Install**</DNT>. Click <DNT>**Start trial**</DNT> to start a free 30-day trial of IAST. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two steps here.
Follow the , , format for instructions.
src="/images/iast_screenshot-full_install.webp" | ||
/> | ||
|
||
Click <DNT>**Set up IAST with applications**</DNT> to start trial of IAST. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Global comment: Ensure all instructions follow [], , format.
|
||
Make sure IAST is not running in the production environment and click <DNT>**Continue**</DNT>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Repeated information.
title="Update the APM agent for Java application language" | ||
> | ||
|
||
Update the APM agent to the latest version. The minimum version supported is: v8.9.0. To update the java agent, follow these on-screen [instructions](https://docs.newrelic.com/docs/apm/agents/java-agent/installation/update-java-agent/) and verify the agent version using the command: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confusing. Are we updating the APM agent or the Java agent?
Capitlization for Java is wrong.
|
||
The code shown above for **Configure the security agent** is the bare minimum requirement to start the IAST. | ||
|
||
To fully configure the IAST, click on `Advanced security agent configurations` and copy the **Security Config** Code. Now open the **newrelic.yml** file and paste the copied code below `high_security: false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not "click on"
copy the Security Config Code > code should be in lowercase
copied code below > copied code after
id="demo-install-nodejs" | ||
title="Configure the Go agent" | ||
> | ||
Configure the security agent by following the below steps: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the below > these
src="/images/configure-go-agent.webp" | ||
/> | ||
|
||
1. Add this integration to your application by importing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
by importing what?
|
||
``` | ||
|
||
1. Please ensure that you wrap your framework router with the WrapRouter function for [Echo](https://pkg.go.dev/github.com/newrelic/go-agent/v3/integrations/nrecho-v4#WrapRouter), [Gin](https://pkg.go.dev/github.com/newrelic/go-agent/v3/integrations/nrgin#WrapRouter), [Gorilla](https://pkg.go.dev/github.com/newrelic/go-agent/v3/integrations/nrgorilla#WrapRouter) frameworks. This is crucial for detecting routes(API endpoints) and enabling provable security in your application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No "please"
This is crucial to detect routes (API endpoints) and to detect
|
||
``` | ||
|
||
**Note:** Skip this step if you are on linux environment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linux capitalization
|
||
**Note:** Skip this step if you are on linux environment. | ||
|
||
1. Based on additional packages imported by the user application, add suitable instrumentation package [Instrumentation packages](https://github.com/newrelic/csec-go-agent#instrumentation-packages). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add the suitable instrumentation packages
|
||
## Test application window | ||
|
||
The below screen will show IAST test results as per your configurations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following screen
</Step> | ||
|
||
<Step> | ||
Click <DNT>**See your data**</DNT> to see an overview of your tested application. | ||
|
||
## Test application window |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this a step?
</Callout> | ||
|
||
## Install New Relic IAST | ||
|
||
There are primarily five stages involved in successful installation of IAST: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many of the screenshots in this article dont seem to add value. Discuss with me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make changes and resubmit.
Please follow conventional commit standards
in your commit messages and pull request title.
Give us some context
links to related docs, screenshots, etc.