DON'T MERGE: Adding dual stack synthetics support docs#23366
DON'T MERGE: Adding dual stack synthetics support docs#23366tthukral-NR-2 wants to merge 8 commits intonewrelic:developfrom
Conversation
|
|
1 similar comment
|
|
|
Hi @tthukral-NR-2 👋 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. Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local. If you really require a preview url, reach out to one of the writers and they will generate one for you. |
|
|
||
| Before you begin, ensure you have the following: | ||
|
|
||
| * <DNT>**Docker**</DNT>: Docker must be installed and running on your host instance |
There was a problem hiding this comment.
Should we include relevant links to NR Docs that would be useful to stand up private location and get users to a state where they satisfy "Docker must be installed and running on your host instance" requirement?
There was a problem hiding this comment.
We have some details on this page But we don't want customers to install SJM at this stage, we just want customers to have the docker and infra ready as a pre-requisite.
| * Ping runtime image (`.tar.gz` or `.tar`) | ||
| * Node API runtime image (`.tar.gz` or `.tar`) | ||
| * Node browser runtime image (`.tar.gz` or `.tar`) | ||
|
|
There was a problem hiding this comment.
where do users get the above images?
There was a problem hiding this comment.
Are these custom images? or all our runtime images are now dual-stack enabled?
There was a problem hiding this comment.
As the title suggests "Install Synthetics for Dual Stack using Docker"
Currently the tar files are in a drive but I'll check once how are we going to go officially out with these tars
|
|
||
| <Callout variant="important"> | ||
| If the ping fails, ensure your VPC, subnet, and security groups are configured to allow IPv6 traffic before continuing with this installation. Your environment must support both IPv4 and IPv6 for Dual Stack operation. | ||
| </Callout> |
There was a problem hiding this comment.
should we include links to NR Docs to help users in these scenarios:
- If the ping fails, ensure your VPC, subnet, and security groups are configured to allow IPv6 traffic before continuing with this installation.
- Your environment must support both IPv4 and IPv6 for Dual Stack operation.
There was a problem hiding this comment.
Here we are referring to infra set up which is a pre-requisite to start setting up dual stack env. We don't commit to provide infra set up, each customer will use their own infra based on their config requirements. We just mentioned to ensure it allows communication for both ipv4 an dipv6
| ## Load custom runtime images [#load-runtime-images] | ||
|
|
||
| Upload the provided Dual Stack-enabled image files to your host instance, then import them into your local Docker engine. | ||
|
|
There was a problem hiding this comment.
where can i find the provided Dual Stack-enabled image files?
There was a problem hiding this comment.
These are the same tar file that customer loads
Tar -> Image
|
|
||
| ## Launch the Synthetics job manager [#launch-job-manager] | ||
|
|
||
| Run the Synthetics job manager container with the custom Dual Stack-enabled runtimes. |
There was a problem hiding this comment.
Should "Custom" be deleted here?
| ``` | ||
|
|
||
| 3. In the New Relic UI, go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Synthetic monitoring > Private locations**</DNT> and verify your private location shows as healthy. | ||
|
|
There was a problem hiding this comment.
Should there be a section for Troubleshooting here? We can consider reusing existing NR Doc links
There was a problem hiding this comment.
Not adding existing docs as dual stack env can bring its own challenges and we don't want to deviate
There was a problem hiding this comment.
If dual stack can bring its own challenges and we can't reuse existing NR Doc links, then it's a gap that needs to be addressed.
Can we anticipate a few failure cases/errors and include a section here? We can build on it later if and when we come across new troubleshooting scenarios.
|
Hello @tthukral-NR-2 could you please address the comments by @newrelicsaurabh and also sign the CLA so that we can go ahead and review the doc |
adutta-newrelic
added
from_internal
tthukral-NR-2
changed the title
4 participants
Please follow conventional commit standards
in your commit messages and pull request title.
Give us some context
links to related docs, screenshots, etc.