Skip to content

Commit

Permalink
Merge pull request #11610 from amolero-nr/develop
Browse files Browse the repository at this point in the history
docs(guided-install): instructions update
  • Loading branch information
rhetoric101 authored Feb 17, 2023
2 parents da67cf8 + cb74138 commit bb4b3b4
Showing 1 changed file with 19 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,31 +37,25 @@ Ready to get started? Click the **Guided install** button. Or, if your account r
</ButtonLink>
</ButtonGroup>

Our infrastructure agent discovers the applications and infrastructure and log sources running in your environment, and recommends which ones should be instrumented. The install automates the configuration and deployment of each system you choose to instrument.
Our guided install discovers the applications, infrastructure and log sources running in your environment, and recommends which ones should be instrumented. The install automates the configuration and deployment of each system you choose to instrument.

<InstallFeedback />

## Why it matters [#why-it-matters]

With our guided install, you can instrument your applications and infrastructure and start seeing your data in New Relic in minutes.

The guided install uses our command line interface (CLI), the [infrastructure agent](/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent) for your host environment, and a library of installation recipes to instrument your applications and infrastructure for you. That means less toil for you.
The guided install uses our command line interface (CLI), the [infrastructure agent](/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent) for your host environment, and a [library of installation recipes](https://github.com/newrelic/open-install-library) to instrument your applications and infrastructure for you. That means less toil for you.

Because our instrumentation recipes are open source, you can modify existing recipes, or build new ones, to suit your needs.

## CLI Flags [#cli-flags]
## CLI flags [#cli-flags]

Customize and debug your installation with CLI flags. Use the "assume yes" flag `-y` for automated installation with sensible defaults, change the verbosity of the output with `--debug` or `--trace`, add tags, or use custom install recipes. You can find a full list of available options in our open source repo on [GitHub](https://github.com/newrelic/newrelic-cli/blob/main/docs/cli/newrelic_install.md).

## Some technical detail [#technical-detail]
## Some technical details [#technical-details]

The New Relic guided install uses open source installation recipes to instrument on-host integrations. These recipes include installation and setup commands, information about logs, and metadata related to what’s being installed. They're collected in a YAML file for each type of system and have all of the installation details necessary to install the infrastructure agent for a specific integration.

<Callout variant="important">
On Windows, our guided install only supports Microsoft SQL Server, logs, and the infrastructure agent.

All other integrations are only supported on Linux.
</Callout>
The New Relic guided install uses open source installation recipes to instrument on-host integrations. These recipes include installation and setup commands, information about logs, and metadata related to what’s being installed. They are written in YAML format for each type of system to be instrumented and have all of the installation details necessary to install the infrastructure agent for a specific integration. Additional information is available in our open source repo on [GitHub](https://github.com/newrelic/open-install-library/blob/main/docs/README.md).

## On-host integration (OHI) recipes [#ohi-recipes]

Expand All @@ -70,7 +64,7 @@ The guided install automates the discovery, configuration, and installation of O
To install any individual on-host integration, you would use a command similar to the following, which specifies the type of integration you want to install. This is the syntax for Linux:

```
curl -Ls https://download.newrelic.com/install/newrelic-cli/scripts/install.sh | bash && sudo NEW_RELIC_API_KEY=INSERT_YOUR_API_KEY NEW_RELIC_ACCOUNT_ID=INSERT_YOUR_RELIC_ACCOUNT_ID /usr/local/bin/newrelic install -n INSERT_THE_INTEGRATION_NAME
curl -Ls https://download.newrelic.com/install/newrelic-cli/scripts/install.sh | bash && sudo NEW_RELIC_API_KEY=INSERT_YOUR_API_KEY NEW_RELIC_ACCOUNT_ID=INSERT_YOUR_ACCOUNT_ID NEW_RELIC_REGION=INSERT_YOUR_REGION /usr/local/bin/newrelic install -n INSERT_THE_INTEGRATION_NAME
```

For example, to install the Apache integration:
Expand All @@ -79,10 +73,22 @@ For example, to install the Apache integration:
curl -Ls https://download.newrelic.com/install/newrelic-cli/scripts/install.sh | bash && sudo NEW_RELIC_API_KEY=<API_KEY> NEW_RELIC_ACCOUNT_ID=<ACCOUNT_ID> /usr/local/bin/newrelic install -n apache-open-source-integration
```

The table lists the integrations supported by the guided install CLI command. The specific on-host integration commands are provided for your reference.
This is the syntax for Windows:

```
[Net.ServicePointManager]::SecurityProtocol = 'tls12, tls'; (New-Object System.Net.WebClient).DownloadFile("https://download.newrelic.com/install/newrelic-cli/scripts/install.ps1", "$env:TEMP\install.ps1"); & PowerShell.exe -ExecutionPolicy Bypass -File $env:TEMP\install.ps1; $env:NEW_RELIC_API_KEY='INSERT_YOUR_API_KEY'; $env:NEW_RELIC_ACCOUNT_ID='INSERT_YOUR_ACCOUNT_ID'; $env:NEW_RELIC_REGION='INSERT_YOUR_REGION'; & 'C:\Program Files\New Relic\New Relic CLI\newrelic.exe' install
```

<Callout variant="important">
On Windows, our guided install only supports Microsoft SQL Server, logs, and the infrastructure agent.

All other integrations are only supported on Linux.
</Callout>

Our open source integrations send performance metrics and inventory data from your servers and applications to the New Relic platform. You can view pre-built dashboards of your metric data, create alert policies, and create your own custom queries and charts.

The table below lists the integrations supported by the guided install CLI command. The specific on-host integration commands are provided for your reference:

<table>
<thead>
<tr>
Expand Down

0 comments on commit bb4b3b4

Please sign in to comment.