Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update enablement and support sections
  • Loading branch information
aso1124 authored Feb 27, 2024
1 parent 290240c commit 414acb2
Showing 1 changed file with 22 additions and 44 deletions.
66 changes: 22 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
[![New Relic One Catalog Project header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/New_Relic_One_Catalog_Project.png)](https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project)

# nr1-container-explorer
# New Relic Container Explorer

![CI](https://github.com/newrelic/nr1-container-explorer/workflows/CI/badge.svg) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/newrelic/nr1-container-explorer?include_prereleases) [![Snyk](https://snyk.io/test/github/newrelic/nr1-container-explorer/badge.svg)](https://snyk.io/test/github/newrelic/nr1-container-explorer)

<a href="https://github.com/newrelic?q=nrlabs-viz&amp;type=all&amp;language=&amp;sort="><img src="https://user-images.githubusercontent.com/1786630/214122263-7a5795f6-f4e3-4aa0-b3f5-2f27aff16098.png" height=50 /></a>

This application is maintained by the New Relic Labs team. Connect with us directly by [creating issues](../../issues) or [starting a discussion](../../discussions) in this repo.

View and manage millions of containers in context - in New Relic One.
View and manage millions of containers in context.

## Usage

Expand All @@ -22,10 +18,6 @@ Clicking on a node in the heatmap displays details about that container, and jum

![Screenshot](./catalog/screenshots/nr1-container-explorer-2.png)

## Open Source License

This project is distributed under the [Apache 2 license](./LICENSE).

## Dependencies

Requires [`New Relic Infrastructure`](https://newrelic.com/products/infrastructure) agent deployed on hosts running Docker containers.
Expand All @@ -52,50 +44,32 @@ an agent's reporting rate. But the reported absolute values may be off.
The infrastructure team is working on agent changes that will properly report by container, at which point
we can convert to using that data.

## Getting started
## Enabling this App

First, ensure that you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [NPM](https://www.npmjs.com/get-npm) installed. If you're unsure whether you have one or both of them installed, run the following command(s) (If you have them installed these commands will return a version number, if not, the commands won't be recognized):
This App is available via the New Relic Catalog.

```bash
git --version
npm -v
```
To enable it in your account:
1. go to `Add Data > Apps and Visualzations` and search for "Container Explorer"
2. Click the `Container Explorer` card, and then click the `Add this App` button to add it to your account(s)
3. Click `Open App` to launch the app (note: on the first time accessing the app, you may be prompted to enable it)

Next, clone this repository and run the following scripts:

```bash
git clone https://github.com/newrelic/nr1-container-explorer.git
cd nr1-container-explorer
npm install
npm start
```
Once you have added your accounts, you can also open the app by:
1. Open the `Apps` left-hand navigation menu item (you may need to click on the `Add More` ellipsis if it doesn't show up by default)
2. In the `Your Apps` section, locate and click on the `Container Explorer` card to open the app

Visit [https://one.newrelic.com/?nerdpacks=local](https://one.newrelic.com/?nerdpacks=local), navigate to the Nerdpack, and :sparkles:

## Deploying this Nerdpack
#### Manual Deployment
If you need to customize the app, fork the codebase and follow the instructions on how to [Customize a Nerdpack](https://developer.newrelic.com/build-apps/customize-nerdpack). If you have a change you feel everyone can benefit from, please submit a PR!

Open a command prompt in the nerdpack's directory and run the following commands.
## Support

```bash
# this is to create a new uuid for the nerdpack so that you can deploy it to your account
nr1 nerdpack:uuid -g [--profile=your_profile_name]
# to see a list of APIkeys / profiles available in your development environment, run nr1 credentials:list
nr1 nerdpack:publish [--profile=your_profile_name]
nr1 nerdpack:deploy [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
```
Visit [https://one.newrelic.com](https://one.newrelic.com), navigate to the Nerdpack, and :sparkles:
## Community Support
The discussions page on this repository is enabled for customers to interact with New Relic employees as well as other customers to get help and share best practices. You can check out the discussions page for this repo [here](../../discussions).
<a href="https://github.com/newrelic?q=nrlabs-viz&amp;type=all&amp;language=&amp;sort="><img src="https://user-images.githubusercontent.com/1786630/214122263-7a5795f6-f4e3-4aa0-b3f5-2f27aff16098.png" height=50 /></a>

You can also interact with us and other customers to troubleshoot issues and share best practices on [New Relic Explorers Hub](https://discuss.newrelic.com).
This project is actively maintained by the New Relic Labs team. Connect with us directly by [creating issues](../../issues) or [asking questions in the discussions section](../../discussions) of this repo.

## Issues / Enhancement Requests
We also encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas.

Issues and enhancement requests can be submitted in the [Issues tab of this repository](../../issues). Please search for and review the existing open issues before submitting a new issue.
New Relic has open-sourced this project, which is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT.

## Security

Expand All @@ -107,3 +81,7 @@ If you believe you have found a security vulnerability in this project or any of
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). Please review our [Contributors Guide](CONTRIBUTING.md).

Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com.

## Open Source License

This project is distributed under the [Apache 2 license](./LICENSE).

0 comments on commit 414acb2

Please sign in to comment.