admin: add and refresh onboarding (#17838)

* refresh onboarding

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
This commit is contained in:
Craig Osterhout 2023-08-01 11:55:25 -07:00 committed by GitHub
parent 045bac977f
commit f55332a467
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 105 additions and 137 deletions

View File

@ -1984,6 +1984,8 @@ manuals:
section:
- path: /admin/organization/
title: Overview
- path: /admin/organization/onboard/
title: Onboard your organization
- path: /admin/organization/members/
title: Manage members
- path: /admin/organization/activity-logs/
@ -2013,12 +2015,8 @@ manuals:
section:
- path: /docker-hub/admin-overview/
title: Overview
- sectiontitle: Onboarding
section:
- path: /docker-hub/onboard-team/
title: Team
- path: /docker-hub/onboard-business/
title: Business
- path: /docker-hub/onboard/
title: Onboard your organization
- sectiontitle: Set up your company
section:
- path: /docker-hub/creating-companies/

View File

@ -0,0 +1,71 @@
{% if include.product == "admin" %}
{% assign sso_link="[Configure SSO](/admin/organization/security-settings/sso/)" %}
{% assign scim_link="[Configure SCIM](/admin/organization/security-settings/scim/)" %}
{% assign members_link="[Invite members](/admin/organization/members/)" %}
{% assign audit_link="[Audit your domains](/admin/organization/security-settings/domains/)" %}
{% else %}
{% assign sso_link="[Configure SSO](/single-sign-on/)" %}
{% assign scim_link="[Configure SCIM](/docker-hub/scim/)" %}
{% assign members_link="[Invite members](/docker-hub/members/)" %}
{% assign audit_link="[Audit your domains](/docker-hub/domain-audit/)" %}
{% endif %}
Onboarding your organization allows you to gain visibility into the activity of your users and enforce security settings. In addition, members of your organization receive increased pull limits and other organization wide benefits. For more details, see [Docker subscriptions and features](/subscription/details/).
## Prerequisites
Before you start to onboard your organization, ensure that you:
- Have a Docker Team or Business subcription. See [Pricing & Subscriptions](https://www.docker.com/pricing/){: target="_blank" rel="noopener" class="_"} for details.
> **Note**
>
> When purchasing a subscription through [Pricing & Subscriptions](https://www.docker.com/pricing/){: target="_blank" rel="noopener" class="_"}, the on-screen instructions guide you through creating an organization. If you have purchased a subscription through Docker Sales and you have not yet created an organization, see [Create an organization](/docker-hub/orgs#create-an-organization).
- Familiarize yourself with Docker concepts and terminology in the [glossary](/glossary/) and [FAQs](/docker-hub/general-faqs/).
## Step 1: Identify your Docker users and their Docker accounts
Identifying your users will ensure that you allocate your subscription seats efficiently and that all your Docker users receive the benefits of your subscription.
1. Identify the Docker users in your organization.
- If your organization uses device management software, like MDM or JAMF, you may use the device management software to help identify Docker users. See your device management software's documentation for details. You can identify Docker users by checking if Docker Desktop is installed at the following location on each user's machine:
- Mac: `/Applications/Docker.app`
- Windows: `C:\Program Files\Docker\Docker`
- Linux: `/opt/docker-desktop`
- If your organization doesn't use device management software or your users haven't installed Docker Desktop yet, you may survey your users.
2. Instruct all your Docker users in your organization to update their existing Docker account's email address to an address that's in your organization's domain, or to create a new account using an email address in your organization's domain.
- To update an account's email address, instruct your users to sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}, go to [Account Settings](https://hub.docker.com/settings/general){: target="_blank" rel="noopener" class="_"}, and update the email address to their email address in your organization's domain.
- To create a new account, instruct your users to go [sign up](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"} using their email address in your organization's domain.
3. Ask your Docker sales representative or [contact sales](https://www.docker.com/pricing/contact-sales/){: target="_blank" rel="noopener" class="_"} to get a list of Docker accounts that use an email address in your organization's domain.
## Step 2: Invite owners
When you create an organization, you are the only owner. You may optionally add additional owners. Owners can help you onboard and manage your organization.
To add an owner, invite a user and assign them the owner role. For more details, see {{ members_link }}.
## Step 3: Invite members
When you add users to your organization, you gain visibility into their activity and you can enforce security settings. In addition, members of your organization receive increased pull limits and other organization wide benefits.
To add a member, invite a user and assign them the member role. For more details, see {{ members_link }}.
## Step 4: Manage members with SSO and SCIM
Configuring Single Sign-On (SSO) or System for Cross-domain Identity Management (SCIM) is optional and only available to Docker Business subscribers. To upgrade a Docker Team subscription to a Docker Business subscription, see [Upgrade your subscription](/subscription/upgrade/).
You can manage your members in your identity provider and automatically provision them to your Docker organization with SSO or SCIM. See the following for more details.
- {{ sso_link }} to automatically provision and add members when they sign in to Docker through your identity provider.
- {{ scim_link }} to automatically provision, add, and de-provision members to Docker through your identity provider.
## Step 5: Enforce sign-in for Docker Desktop
By default, members of your organization can use Docker Desktop on their machines without signing in to any Docker account. You must enforce sign-in to ensure that users receive the benefits of your Docker subscription and that security settings are enforced. For details, see [Configure registry.json to enforce sign-in](/docker-hub/configure-sign-in/).
## What's next
- [Create](/docker-hub/repos/create/) and [manage](/docker-hub/repos/) repositories.
- Create [teams](/docker-hub/manage-a-team/) for fine-grained repository access.
- Configure [Hardened Docker Desktop](/desktop/hardened-desktop/) to improve your organizations security posture for containerized development.
- {{ audit_link }} to ensure that all Docker users in your domain are part of your organization.
Your Docker subscription provides many more additional features. To learn more, see [Docker subscriptions and features](/subscription/details/).

View File

@ -0,0 +1,11 @@
---
description: Get started onboarding your Docker Team or Business organization.
keywords: business, team, organizations, get started, onboarding
title: Onboard your organization
toc_min: 1
toc_max: 2
---
{% include admin-early-access.md %}
{% include admin-org-onboarding.md product="admin" %}

View File

@ -14,17 +14,17 @@ Sign in to Docker Hub to change account settings and carry out administrative or
<div class="component-icon">
<a href="/docker-hub/orgs/"><img src="/assets/images/contact.svg" alt="Set-up-an-org" width="70" height="70"></a>
</div>
<h2 id="set-up-an-org">Set up an organization</h2>
<p> <a href="/docker-hub/orgs/">Explore and set up an organization in Docker Hub</a></p>
<h2 id="set-up-an-org"><a href="/docker-hub/orgs/">Create your organization</a></h2>
<p>Explore and set up an organization in Docker Hub.</p>
</div>
</div>
<div class="col-xs-12 col-sm-12 col-md-12 col-lg-4 block">
<div class="component">
<div class="component-icon">
<a href="/docker-hub/orgs/"><img src="/assets/images/explore.svg" alt="onboard" width="70" height="70"></a>
<a href="/docker-hub/onboard/"><img src="/assets/images/explore.svg" alt="onboard" width="70" height="70"></a>
</div>
<h2 id="onboard-users">Onboard users to your teams and organizations</h2>
<p>Learn how to onboard with <a href="/docker-hub/onboard-team/">Docker Team</a> or <a href="/docker-hub/onboard-business/">Docker Business</a> subscription.</p>
<h2 id="onboard-users"> <a href="/docker-hub/onboard/">Onboard your organization</a></h2>
<p>Learn how to onboard users to your organization.</p>
</div>
</div>
<div class="col-xs-12 col-sm-12 col-md-12 col-lg-4 block">
@ -44,8 +44,8 @@ Sign in to Docker Hub to change account settings and carry out administrative or
<div class="component-icon">
<a href="/docker-hub/configure-sign-in/"><img src="/assets/images/sign-on.svg" alt="sign-in" width="70" height="70"></a>
</div>
<h2 id="sign-in"><a href="/docker-hub/configure-sign-in/">Enforce sign in</a></h2>
<p>Configure sign in for members of your teams and organizations.</p>
<h2 id="sign-in"><a href="/docker-hub/configure-sign-in/">Enforce sign-in</a></h2>
<p>Configure sign-in for members of your teams and organizations.</p>
</div>
</div>
<div class="col-xs-12 col-sm-12 col-md-12 col-lg-4 block">

View File

@ -1,67 +0,0 @@
---
description: Docker Business onboarding
keywords: business, organizations, get started, onboarding
title: Docker Business onboarding
toc_min: 1
toc_max: 2
---
The following section contains step-by-step instructions on how to get started onboarding your organization after you have an organization with a Docker Business subscription.
## Prerequisites
Before you start to on board your organization, ensure that you:
- [Create an organization](../docker-hub/orgs.md#create-an-organization) with a Docker Business subscription.
- Familiarize yourself with Docker concepts and terminology in the [glossary](../glossary.md) and [FAQs](../docker-hub/general-faqs.md).
## Step 1: Identify your Docker users and their Docker accounts
To begin, you should identify which users you will need to add to your Docker Business organization. Identifying your users will help you efficiently allocate your subscription's seats and manage access.
1. Identify the Docker users in your organization.
- If your organization uses device management software, like MDM or JAMF, you may use the device management software to help identify Docker users. See your device management software's documentation for details. You can identify Docker users by checking if Docker Desktop is installed at the following location on each user's machine:
- Mac: `/Applications/Docker.app`
- Windows: `C:\Program Files\Docker\Docker`
- Linux: `/opt/docker-desktop`
- If your organization doesn't use device management software, you may survey your users.
2. Instruct all your Docker users in your organization to update their existing Docker account's email address to an address that's in your organization's domain, or to create a new account using an email address in your organization's domain.
- To update an account's email address, instruct your users to sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}, go to [Account Settings](https://hub.docker.com/settings/general){: target="_blank" rel="noopener" class="_"}, and update the email address to their email address in your organization's domain.
- To create a new account, instruct your users to go [sign up](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"} using their email address in your organization's domain.
3. Ask your Docker sales representative to provide a list of Docker accounts that use an email address in your organization's domain.
## Step 2: Invite owners
Now that you have a Docker Business organization, it's time to start adding owners to help you set up and manage your organization. Owners can add or remove members, and configure Single Sign-on as well as other security settings.
To add an owner, invite a user and assign them the owner role. For more details, see [Invite members](../docker-hub/members.md/#invite-members){: target="_blank" rel="noopener" class="_"}.
## Step 3: Invite members
Add members to your organization using a CSV file, or by entering their email addresses. For more details, see [Invite members](../docker-hub/members.md/#invite-members){: target="_blank" rel="noopener" class="_"}
## Step 4: Manage members with SSO and SCIM
Automate adding members to your organization using the following:
- Single Sign-on: Automatically provision and add members when they sign in to Docker Hub through your identity provider. For details, see [Single Sign-on overview](../single-sign-on/index.md).
- System for Cross-domain Identity Management: Automatically provision, add, and de-provision members from your identity provider. For details, see [SCIM](../docker-hub/scim.md).
## Step 5: Enforce sign-in for Docker Desktop
By default, members of your organization can use Docker Desktop on their machines without signing in to any Docker account. To ensure that a user signs in to a Docker account that is a member of your organization and that the
organizations settings apply to the users session, you can use a `registry.json` file. For details, see [Configure registry.json to enforce sign-in](../docker-hub/configure-sign-in.md){: target="_blank" rel="noopener" class="_"}.
## What's next
Configure security settings and manage your repositories:
- Create [repositories](../docker-hub/repos/index.md) to share container images.
- [Move images](../docker-hub/repos/index.md/#move-images-between-repositories) from your personal account to your organization.
- Create [teams](manage-a-team.md) and configure [repository permissions](manage-a-team.md#configure-repository-permissions-for-a-team).
- Configure [Hardened Docker Desktop](../desktop/hardened-desktop/index.md) to improve your organizations security posture for containerized development. Hardened Docker Desktop includes:
- [Settings Management](../desktop/hardened-desktop/settings-management/index.md), which helps you to confidently manage and control the usage of Docker Desktop within your organization.
- [Enhanced Container Isolation](../desktop/hardened-desktop/enhanced-container-isolation/index.md), a setting that instantly enhances security by preventing containers from running as root in Docker Desktops Linux VM.
- [Image Access Management](../docker-hub/image-access-management.md/), lets you control which images developers can pull from Docker Hub.
- [Registry Access Management](../docker-hub/registry-access-management.md/), lets you control the registries developers can access.
- [Audit your domains](../docker-hub/domain-audit.md) to identify Docker users who have authenticated to Docker using an email address associated with one of your verified domains, but theyre not a member of your organization in Docker.
Your Docker Business subscription provides many more additional features. [Learn more](../subscription/index.md).

View File

@ -1,57 +0,0 @@
---
description: Docker Team onboarding
keywords: team, organizations, get started, onboarding
title: Docker Team onboarding
toc_min: 1
toc_max: 2
---
The following section contains step-by-step instructions on how to get started onboarding your organization after you have an organization with a Docker Team subscription.
## Prerequisites
Before you start to on board your organization, ensure that you:
- [Create an organization](../docker-hub/orgs.md#create-an-organization) with a Docker Team subscription.
- Familiarize yourself with Docker concepts and terminology in the [glossary](../glossary.md) and [FAQs](../docker-hub/general-faqs.md).
## Step 1: Identify your Docker users and their Docker accounts
To begin, you should identify which users you will need to add to your Docker Team organization. Identifying your users will help you efficiently allocate your subscription's seats and manage access.
1. Identify the Docker users in your organization.
- If your organization uses device management software, like MDM or JAMF, you may use the device management software to help identify Docker users. See your device management software's documentation for details. You can identify Docker users by checking if Docker Desktop is installed at the following location on each user's machine:
- Mac: `/Applications/Docker.app`
- Windows: `C:\Program Files\Docker\Docker`
- Linux: `/opt/docker-desktop`
- If your organization doesn't use device management software, you may survey your users.
2. Instruct all your Docker users in your organization to update their existing Docker account's email address to an address that's in your organization's domain, or to create a new account using an email address in your organization's domain.
- To update an account's email address, instruct your users to sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}, go to [Account Settings](https://hub.docker.com/settings/general){: target="_blank" rel="noopener" class="_"}, and update the email address to their email address in your organization's domain.
- To create a new account, instruct your users to go [sign up](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"} using their email address in your organization's domain.
3. Ask your Docker sales representative to provide a list of Docker accounts that use an email address in your organization's domain.
## Step 2: Invite owners
Now that you have a Docker Team organization, it's time to start adding owners to help you set up and manage your organization. Owners can add or remove members, and configure other organization settings.
To add an owner, invite a user and assign them the owner role. For more details, see [Invite members](../docker-hub/members.md/#invite-members){: target="_blank" rel="noopener" class="_"}.
## Step 3: Invite members
Add members to your organization using a CSV file, or by entering their email addresses. For more details, see [Invite members](../docker-hub/members.md/#invite-members){: target="_blank" rel="noopener" class="_"}
## Step 4: Enforce sign-in for Docker Desktop
By default, members of your organization can use Docker Desktop on their machines without signing in to any Docker account. To ensure that a user signs in to a Docker account that is a member of your organization and that the
organizations settings apply to the users session, you can use a `registry.json` file. For details, see [Configure registry.json to enforce sign-in](../docker-hub/configure-sign-in.md){: target="_blank" rel="noopener" class="_"}.
## What's next
Create and manage your repositories:
- Create [repositories](../docker-hub/repos/index.md) to share container images.
- [Consolidate a repository](../docker-hub/repos/index.md/#move-images-between-repositories) from your personal account to your organization.
- Create [teams](manage-a-team.md#create-a-team) and configure [repository permissions](manage-a-team.md#configure-repository-permissions-for-a-team).
Your Docker Team subscription provides many more additional features. [Learn more](../subscription/index.md).

12
docker-hub/onboard.md Normal file
View File

@ -0,0 +1,12 @@
---
description: Get started onboarding your Docker Team or Business organization.
keywords: business, team, organizations, get started, onboarding
title: Onboard your organization
toc_min: 1
toc_max: 2
redirect_from:
- /docker-hub/onboard-team/
- /docker-hub/onboard-business/
---
{% include admin-org-onboarding.md %}