Skip to content

Commit

Permalink
Merge branch 'develop' into rhs-otel-collector-infra
Browse files Browse the repository at this point in the history
  • Loading branch information
rhetoric101 committed Mar 31, 2022
2 parents a1aab49 + fdd1220 commit 8520b4d
Show file tree
Hide file tree
Showing 456 changed files with 10,216 additions and 5,992 deletions.
Binary file added .github/.CODEOWNERS.swp
Binary file not shown.
8 changes: 4 additions & 4 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# .github directory & its subdirectories
/.github/ @newrelic/developer-enablement
/.github/ @newrelic/docs-engineering

# all javascript files
*.js @newrelic/developer-enablement
*.js @newrelic/docs-engineering

yarn.lock @newrelic/developer-enablement
yarn.lock @newrelic/docs-engineering

# Whats new files (pings individual project marketing managers)

/src/content/whats-new/ @ishanmkh @jkinmonth @alexiskjones @B1XR11L729w583adTl5899556EJ5322a @daynaslord
/src/content/whats-new/ @jkinmonth @alexiskjones @daynaslord
4 changes: 2 additions & 2 deletions .github/workflows/check-translations-and-deserialize.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
base: develop
delete-branch: true
reviewers: jmiraNR
team-reviewers: developer-enablement
team-reviewers: docs-engineering

- name: Remove Completed Batches From Queue
if: steps.fetch-deserialize.outputs.successfulTranslations != 0 && steps.create-pr.outcome == 'success'
Expand Down Expand Up @@ -144,7 +144,7 @@ jobs:
base: develop
delete-branch: true
reviewers: jmiraNR
team-reviewers: developer-enablement
team-reviewers: docs-engineering

- name: Remove Completed Batches From Queue
if: steps.fetch-deserialize.outputs.successfulTranslations != 0 && steps.create-pr.outcome == 'success'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/update-whats-new-ids.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ jobs:
})
console.log("Result:", result)
# Push directly to the `develop` branch so we get the changes included in the release PR
# Push directly to the `develop` branch so we get the changes included in the release PR
- name: Push Commit
if: steps.commit-changes.outputs.commit == 'true'
uses: ad-m/github-push-action@v0.6.0
Expand Down Expand Up @@ -93,7 +93,7 @@ jobs:
},
restrictions: {
users: [],
teams: ['developer-enablement']
teams: ['docs-engineering']
},
enforce_admins: null,
required_pull_request_reviews: {
Expand Down
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Unit tests](#unit-tests)
- [Using multiple versions of Node](#using-multiple-versions-of-node)
- [Cloning vs forking](#cloning-vs-forking)
- [Forks - GitHub Workflows / Actions](#forks---github-workflows--actions)
- [Submitting a PR from a forked repo](#submitting-a-pr-from-a-forked-repo)
- [Submitting a PR from a cloned repo](#submitting-a-pr-from-a-cloned-repo)
- [Using the `develop` branch](#using-the-develop-branch)
Expand Down Expand Up @@ -79,15 +80,15 @@ which clearly explains the setup and configuration of NVM.

### Cloning vs forking

To be able to [clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repository and contribute you will need to be given write access to the repository. This is reserved for New Relic Doc Writers. Contact the Developer Enablement team (#help-deven-websites Slack channel) if you need write access.
To be able to [clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repository and contribute you will need to be given write access to the repository. This is reserved for New Relic Doc Writers. Contact the Docs Engineering team (#help-documentation Slack channel) if you need write access.

To contribute without write access, you can [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the repository and contribute as needed. If you're planning to leave a fork open for a long time (for example, you're working on a complex set of changes to many docs), [sync your fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) occasionally to avoid merge conflicts.

#### Forks - GitHub Workflows / Actions

This repository contains workflows that are not meant to be run on forks. If they do run, they will fail and generate alerts on every failed run.
This repository contains workflows that are not meant to be run on forks. If they do run, they will fail and generate alerts on every failed run.

By default, a user should see a prompt like this after cloning the repo when looking at the actions tab:
By default, a user should see a prompt like this after cloning the repo when looking at the actions tab:

![Disabled GitHub Actions](src/images/workflows_disabled_by_default.png 'disabled-workflows-prompt')

Expand Down Expand Up @@ -173,8 +174,8 @@ As a reminder, here's the format for a single-line commit, but you are welcome t
<type>(optional scope): <description>
```

When choosing a type, you can pick from any of the standard types (feat, fix, style, test, or chore) or you can add your own.
**Note**: There is a `documentation` type, but please refrain from using it for general documentation changes since it is intended for changes to the repository's documentation (such as `README.md` and `CONTRIBUTING.md`)
When choosing a type, you can pick from any of the standard types (feat, fix, style, test, or chore) or you can add your own.
**Note**: There is a `documentation` type, but please refrain from using it for general documentation changes since it is intended for changes to the repository's documentation (such as `README.md` and `CONTRIBUTING.md`)

As far as scope, we recommend that you include this because it helps us identify relevant commits. For the docs project, the scope might refer to the part of the docs you are editing (for example, APM or errors inbox). If you are suggesting a code change to the docs site, insert the section of the codebase you worked on.

Expand Down
2 changes: 1 addition & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const getAgentName = require('./src/utils/getAgentName');

const dataDictionaryPath = `${__dirname}/src/data-dictionary`;
const siteUrl = 'https://docs.newrelic.com';
const additionalLocales = ['jp'];
const additionalLocales = ['jp', 'kr'];

const autoLinkHeaders = {
resolve: 'gatsby-remark-autolink-headers',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,16 @@ module.exports = {
deferrable: Deferrable.INITIALLY_IMMEDIATE,
},
},
project_id: {
type: DataTypes.TEXT,
allowNull: true,
},
date_created: {
type: DataTypes.DATE,
},
date_modified: {
type: DataTypes.DATE,
},
project_id: {
type: DataTypes.TEXT,
allowNull: true,
},
});
await queryInterface.createTable('translations', {
id: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ If you've created a new New Relic organization that you don't need, and if it me

Requirements to be able to delete your own organization:
* Organization has a single account, and single user.
* Is on both the new [pricing model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-changes-pricing-user-model#pricing-plans) and the [New Relic One user model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-changes-pricing-user-model#user-models)).
* Is on both the new [pricing model](/docs/accounts/original-accounts-billing/original-product-based-pricing/overview-changes-pricing-user-model#pricing-plans) and the [New Relic One user model](/docs/accounts/original-accounts-billing/original-users-roles/overview-user-models).

</Collapser>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ This query breaks down [Metric data](/docs/telemetry-data-platform/understand-da
</Collapser>
</CollapserGroup>

## Data ingest and query limits [#data-limits]

For information about data ingest limits and query limits, see [Query system limits](/docs/data-apis/manage-data/query-limits).

## User count queries [#user-queries]

For a display of your user count, see the [usage UI](/docs/accounts/accounts-billing/new-relic-one-pricing-billing/billing-ui). If you need more detail than that, you can use the example NRQL queries below. For details about how users are calculated, see [User calculations](/docs/accounts/accounts-billing/new-relic-one-pricing-billing/user-count-billing).
Expand Down Expand Up @@ -265,6 +269,9 @@ Here are some NRQL alert condition examples.
</Collapser>
</CollapserGroup>

For setting up alerts related to data ingest limits and query limits, see [Set alerts for hitting data limits](/docs/data-apis/manage-data/query-limits#set-alerts-on-resource-metrics).


## Query changes to your account [#account-changes]

To see changes made to your account (for example, changes related to managing users), you can query [`NrAuditEvent`](/docs/insights/insights-data-sources/default-data/nrauditevent-event-data-query-examples).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,6 @@ This doc is for managing users on the [New Relic One user model](/docs/accounts/

To manage their users, New Relic organizations can configure one or more authentication domains, which control how users are added to a New Relic account, how they’re authenticated, and more.

## Requirements [#requirements]

To check if you have access to these features, you can go to the [authentication domain settings UI](#ui) and see if you can configure settings.

Requirements to configure these settings:

* These features are for managing users on the [New Relic One user model](/docs/accounts/accounts-billing/new-relic-one-pricing-users/users-roles). For users on our original user model, see [Original account management](/docs/accounts/original-accounts-billing).
* Configuring these settings requires [Pro or Enterprise edition](https://newrelic.com/pricing).
* To edit these settings, you must be in a group with the [**Authentication domain manager** role](/docs/accounts/accounts-billing/new-relic-one-pricing-users/users-roles#standard-roles).
* [SCIM provisioning](/docs/accounts/accounts/automated-user-management/automated-user-provisioning-single-sign), also known as automated user management requires Pro or Enterprise edition.
* SAML SSO requires Pro or Enterprise edition. SAML support includes:
* [Active Directory Federation Services (ADFS)](http://technet.microsoft.com/en-us/library/hh831502.aspx "Link opens in a new window")
* [Auth0](https://marketplace.auth0.com/integrations/new-relic-sso)
* [Azure AD (Microsoft Azure Active Directory)](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/new-relic-limited-release-tutorial)
* [Okta](http://www.okta.com/newrelic)
* [OneLogin](http://www.onelogin.com/partners/app-partners/new-relic/)
* [Ping Identity](https://www.pingidentity.com/en.html)
* [Salesforce](http://wiki.developerforce.com/page/Configuring-SAML-SSO-to-NewRelic)
* Generic support for SSO systems that use SAML 2.0

## What is an authentication domain? [#auth-domain-definition]

An "authentication domain" is a grouping of New Relic users governed by the same user management settings, like [how they're provisioned](#source-users) (added and updated), [how they're authenticated](#authentication) (logged in), [session settings](#session-mgmt), and [how user upgrades are managed](#session-mgmt).
Expand All @@ -51,6 +31,28 @@ When you add users to New Relic, they’re added to a specific authentication do

<Video id="Z00-KzGh2XY" type="youtube" />

## Requirements [#requirements]

Authentication domains are for managing users on the [New Relic One user model](/docs/accounts/accounts-billing/new-relic-one-pricing-users/users-roles). If your users are on our original user model, see [Original accounts](/docs/accounts/original-accounts-billing/original-users-roles/original-account-structure).

Requirements to manage authentication domains:

* Your organization must be either [Pro or Enterprise edition](https://newrelic.com/pricing) to have editable authentication domains.
* To view or edit authentication domains, a user must:
* Have a [user type](/docs/accounts/accounts-billing/new-relic-one-user-management/user-type) of core user or full platform user.
* Be in a group with the [**Authentication domain manager** role](/docs/accounts/accounts-billing/new-relic-one-pricing-users/users-roles#standard-roles).
* SCIM provisioning, also known as automated user management, requires Pro or Enterprise edition. [Learn more about requirements.](/docs/accounts/accounts/automated-user-management/automated-user-provisioning-single-sign)
* SAML SSO requires Pro or Enterprise edition. Our SAML SSO support includes:
* [Active Directory Federation Services (ADFS)](http://technet.microsoft.com/en-us/library/hh831502.aspx)
* [Auth0](https://marketplace.auth0.com/integrations/new-relic-sso)
* [Azure AD (Microsoft Azure Active Directory)](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/new-relic-limited-release-tutorial)
* [Google](https://support.google.com/a/answer/6363863)
* [Okta](http://www.okta.com/newrelic)
* [OneLogin](https://www.onelogin.com/partners/technology-partners/new-relic)
* [Ping Identity](https://www.pingidentity.com/en.html)
* [Salesforce](http://wiki.developerforce.com/page/Configuring-SAML-SSO-to-NewRelic)
* Generic support for SSO systems that use SAML 2.0

## Create and configure an authentication domain [#ui]

If you meet the [requirements](#requirements), you can add and manage authentication domains.
Expand All @@ -61,7 +63,7 @@ If you have existing domains, they'll be on the left. Note that most organizatio

To create a new domain from the authentication domain UI page, click **Create new**. For more about the configuration options, keep reading.

## Source of users: Manual versus SCIM [#source-users]
## Source of users: manual provisioning versus SCIM provisioning [#source-users]

<Callout variant="tip">
For an introduction to our SAML SSO and SCIM offerings, please read [Get started with SSO and SCIM](/docs/accounts/accounts-billing/new-relic-one-user-management/introduction-saml-scim).
Expand All @@ -78,7 +80,7 @@ Notes on these settings:

For how to set up SCIM, see [Automated user management](/docs/accounts/accounts/automated-user-management/automated-user-provisioning-single-sign).

## Authentication [#authentication]
## Authentication: username/password versus SAML SSO [#authentication]

The authentication method is the way in which New Relic users log in to New Relic. All users in an authentication domain have a single authentication method. There are two authentication options:

Expand Down Expand Up @@ -184,12 +186,12 @@ More on these two options:
id="manage-user-type-new-relic"
title="Manage user type in New Relic (default)"
>
Our default functionality is to manage user type from New Relic. This is the option you'd use if you weren't [managing user type via SCIM](#source-users). The management options governed by this include:
The default way to manage your users' user type is from the New Relic UI. This is the option you'd use if you aren't [managing user type via SCIM](#manage-user-type-scim). The management options governed by this include:

* The ability to change user type in the [**User management** UI](/docs/accounts/accounts-billing/new-relic-one-user-management/user-management-ui-and-tasks#where).
* The ability to manage how user type upgrade requests are handled. These options include:
* **Allow users to self-upgrade**: this allows basic users to be able to immediately upgrade to a higher user type on their own, without approval. This allows these users to be able to more quickly respond to issues.
* **Require review**: with this option, admins (users with the **authentication domain manager** role) receive an email when a user requests an upgrade, and can approve or deny those requests in the [**User management** UI](/docs/accounts/accounts-billing/new-relic-one-user-management/user-management-ui-and-tasks#where).
* **Allow users to self-upgrade**: this allows users to be able to immediately upgrade to a higher user type on their own, without approval. This allows these users to be able to more quickly respond to issues.
* **Require review**: with this option, admins (users with the [**Authentication domain manager** role](/docs/accounts/accounts-billing/new-relic-one-user-management/user-management-concepts/#standard-roles)) receive an email when a user requests an upgrade, and can approve or deny those requests in the [**User management** UI](/docs/accounts/accounts-billing/new-relic-one-user-management/user-management-ui-and-tasks#where).
</Collapser>

<Collapser
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Here are our docs about managing New Relic One user model users:
* [User permission concepts](/docs/accounts/accounts-billing/new-relic-one-user-management/user-management-concepts): learn about how users get access to specific capabilities and to specific accounts.
* [User type](/docs/accounts/accounts-billing/new-relic-one-user-management/user-type): learn about basic users, core users, and full platform users.
* [Common user management tasks](/docs/accounts/accounts-billing/new-relic-one-user-management/user-management-ui-and-tasks/): learn where to find the user management UI, how to add users, edit user type, add users to groups, create custom roles, and more.
* [Introduction to SAML SSO and SCIM](/docs/accounts/accounts-billing/new-relic-one-user-management/introduction-saml-scim): an overview of SAML SSO and SCIM options.
* [Authentication domain settings](/docs/accounts/accounts-billing/new-relic-one-pricing-users/configure-authentication-domains): an "authentication domain" is what governs how users in that domain are added to New Relic (manually versus SCIM provisioning), the authentication method used by those users (manual login versus SAML SSO), managing how users upgrade their user type, and user session settings.
* [User management tutorials](/docs/accounts/accounts-billing/new-relic-one-user-management/tutorial-add-new-user-groups-roles-new-relic-one-user-model): more in-depth tutorials for user management tasks.
* [User management UI videos](/docs/accounts/accounts-billing/new-relic-one-user-management/user-mgmt-videos): watch videos of the user management UI in action.
* [Introduction to SAML and SCIM](/docs/accounts/accounts-billing/new-relic-one-user-management/introduction-saml-scim): an overview of SAML SSO and SCIM options.

Want to understand how user count affects billing? See [User-related billing](/docs/accounts/accounts-billing/new-relic-one-pricing-users/new-relic-one-pricing-billing#user-count).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For setting up automatic controls over how your New Relic users are added to New

* **SAML SSO**: this allows your users to use a single sign-on (SSO) identity provider service to log in to New Relic, as opposed to using the default email + password.
* Requirements: [Pro or Enterprise edition](https://newrelic.com/pricing).
* **SCIM provisioning**, also referred to as automated user management: SCIM provisioning allows organizations to use their identity provider service to automate how their users are added to and updated in New Relic. By definition, SCIM provisioning requires use of SAML SSO, but SAML SSO doesn't require SCIM.
* **SCIM provisioning**, also referred to as automated user management: SCIM provisioning allows organizations to use their identity provider service to automate how their users are added to and updated in New Relic. Organizations using SCIM will almost always use SAML SSO.
* Requirements: [Pro or Enterprise edition](https://newrelic.com/pricing), and using this adds users on the New Relic One user model (more on that below).

Before enabling these, it's important to understand an important factor that affects these features: the user model that your users are on. In 2020, we released a new and improved user model, called the [New Relic One user model](/docs/accounts/original-accounts-billing/original-users-roles/overview-user-models). At first, mainly new customers made use of this model, but now it’s available to some of our older customers via a [user migration procedure](/docs/accounts/original-accounts-billing/original-users-roles/user-migration/). Over time, all New Relic users will be migrated to this model.
Expand Down

0 comments on commit 8520b4d

Please sign in to comment.