Skip to content

Commit

Permalink
Sync from github/docs@9e998cf by PCIT
Browse files Browse the repository at this point in the history
  • Loading branch information
khs1994 committed Nov 15, 2024
1 parent 2bd7bf5 commit 8f68479
Show file tree
Hide file tree
Showing 20 changed files with 191 additions and 108 deletions.
4 changes: 2 additions & 2 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -1704,18 +1704,18 @@
* [Configuring Your Copilot Agent To Communicate With Git Hub](copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md)
* [Configuring Your Copilot Agent To Communicate With The Copilot Platform](copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md)
* [Building A Copilot Agent For Your Copilot Extension](copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md)
* [Using A Demo Agent](copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-a-demo-agent.md)
* [Using Copilot S LLM For Your Agent](copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md)
- Creating A Copilot Extension
* [Configuring Your Git Hub App For Your Copilot Agent](copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-agent.md)
* [Configuring Your Server To Deploy Your Copilot Agent](copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent.md)
* [Configuring Your Server To Host Your Copilot Agent](copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-agent.md)
* [Creating A Git Hub App For Your Copilot Extension](copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md)
* [Creating A Copilot Extension](copilot/building-copilot-extensions/creating-a-copilot-extension/index.md)
* [About Building Copilot Extensions](copilot/building-copilot-extensions/about-building-copilot-extensions.md)
* [Copilot Extensions Glossary](copilot/building-copilot-extensions/copilot-extensions-glossary.md)
* [Debugging Your Git Hub Copilot Extension](copilot/building-copilot-extensions/debugging-your-github-copilot-extension.md)
* [Building Copilot Extensions](copilot/building-copilot-extensions/index.md)
* [Managing The Availability Of Your Copilot Extension](copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md)
* [Quickstart For Git Hub Copilot Extensions](copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions.md)
* [Setting Up Copilot Extensions](copilot/building-copilot-extensions/setting-up-copilot-extensions.md)
- Customizing Copilot
* [Adding Custom Instructions For Git Hub Copilot](copilot/customizing-copilot/adding-custom-instructions-for-github-copilot.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@ After you add an existing organization to your enterprise, the organization's re

* **SAML SSO Configuration:**

* If SAML SSO is configured **for the enterprise**, the enterprise's SAML configuration will apply to the organization. If the organization used SAML SSO, the enterprise account's configuration will replace the organization's configuration. SCIM is not available for enterprise accounts, so SCIM will be disabled for the organization. See "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise)" and "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
* If SAML SSO was configured **for the organization**, members' existing {% data variables.product.pat_generic %} or SSH keys that were authorized to access the organization's resources will be authorized to access the same resources. To access additional organizations owned by the enterprise, members must authorize the {% data variables.product.pat_generic %} or key. See "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."
* If SAML SSO is configured **for the destination enterprise**, the enterprise's SAML configuration will apply to the organization.
* If SAML is currently configured on the organization, the enterprise account's SAML configuration will override the organization's configuration. SCIM is not available at the enterprise level for enterprises that use personal accounts, so SCIM will be disabled for the organization. The new inherited enterprise SAML settings will be displayed on the organization's SAML settings page.
* If SAML is ever disabled for the enterprise, the organization SAML settings will revert back to their original configuration.
* If SAML is **not** configured for the destination enterprise, the organization will retain any existing SAML and SCIM settings.
* If organization members have existing SAML authorizations for {% data variables.product.pat_generic_plural %} or SSH keys to access the organization, these authorizations will remain active.
* To see these authorizations, SAML must be configured for either the organization or enterprise, and the user must have a linked SAML identity.
* To access additional organizations owned by the enterprise, members must authorize the {% data variables.product.pat_generic %} or key. See "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."

* **Trial enterprise:** Certain features may be disabled if added to a trial enterprise. See "[AUTOTITLE](/admin/overview/setting-up-a-trial-of-github-enterprise-cloud#features-not-included-in-the-trial)."
* **{% data variables.product.prodname_github_connect %}:** If the organization was connected to {% data variables.product.prodname_ghe_server %} using {% data variables.product.prodname_github_connect %}, adding the organization to an enterprise will not update the connection. {% data variables.product.prodname_github_connect %} features will no longer function for the organization. To continue using {% data variables.product.prodname_github_connect %}, you must disable and re-enable the feature. See "[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/managing-github-connect)" in the {% data variables.product.prodname_ghe_server %} documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,25 @@ redirect_from:
- /admin/user-management/managing-organizations-in-your-enterprise/removing-organizations-from-your-enterprise
---

## About organization removal

You can remove an organization that is owned by your enterprise account, so the organization stands alone.

> [!WARNING]
> When you remove an organization from your enterprise:
> * Billing, identity management, 2FA requirements, and other policies for the organization will no longer be governed by your enterprise.
> * The organization will be downgraded to the free plan.
> * The organization will be governed by our standard Terms of Service.
> * Any internal repositories within the organization will be converted to private repositories.
## What happens when an organization is removed?

When you remove an organization from your enterprise:

* Billing, identity management, 2FA requirements, and other policies for the organization will no longer be governed by your enterprise.
* The organization will be downgraded to the free plan.
* The organization will be governed by our standard Terms of Service.
* Any internal repositories within the organization will be converted to private repositories.

As part of the downgrade to the free plan:

* Protected branch and ruleset configurations will be retained in your settings, but will no longer be applied in private repositories.
* Existing pull request drafts will remain in draft status. New drafts cannot be created.
* CODEOWNERS files will no longer be applied in private repositories.
* Private {% data variables.product.prodname_pages %} sites will no longer be available.
* Wikis will be retained, but won't be visible unless the organization is upgraded to {% data variables.product.prodname_team %}.
* Secrets will be retained, but will not be accessible in private repositories unless the organization is upgraded to {% data variables.product.prodname_team %}.

## Removing an organization from your enterprise

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,8 @@ However, not all the data for {% data variables.product.prodname_actions %} is i

To restore a backup of {% data variables.location.product_location %} with {% data variables.product.prodname_actions %}, you must manually configure network settings and external storage on the destination instance before you restore your backup from {% data variables.product.prodname_enterprise_backup_utilities %}.

1. Confirm that the source instance is offline.
1. Manually configure network settings on the replacement {% data variables.product.prodname_ghe_server %} instance. Network settings are excluded from the backup snapshot, and are not overwritten by `ghe-restore`. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings)."
1. SSH into the destination instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)."

```shell copy
ssh -p 122 admin@HOSTNAME
```

1. Configure the destination instance to use the same external storage service for {% data variables.product.prodname_actions %} as the source instance by entering one of the following commands.
{% data reusables.actions.configure-storage-provider-platform-commands %}
{% data reusables.actions.configure-storage-provider %}
1. To prepare to enable {% data variables.product.prodname_actions %} on the destination instance, enter the following command.

```shell copy
ghe-config app.actions.enabled true
```

{% data reusables.actions.apply-configuration-and-enable %}
1. Create a new instance with the "New Install" option. For installation instructions for the virtualization platform of your choice, see "[AUTOTITLE](/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance)."
1. In the {% data variables.enterprise.management_console %}, configure network settings and external storage for {% data variables.product.prodname_actions %} on the destination instance. See "[AUTOTITLE](/admin/configuring-settings)."
1. After {% data variables.product.prodname_actions %} is configured and enabled, to restore the rest of the data from the backup, use the `ghe-restore` command. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance#restoring-a-backup)."
1. Re-register your self-hosted runners on the destination instance. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
1. {% ifversion ghes < 3.12 %}Optionally, to{% else %}To{% endif %} ensure that the bundled actions that are pre-installed on your new instance are up to date, enter the following command.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ After the initial configuration of SAML SSO, the only setting you can update on
> [!NOTE]
> {% data reusables.enterprise-accounts.emu-password-reset-session %}
1. If you're using a **non-partner IdP** (an IdP other than Okta, PingFederate or Entra ID), before enabling SAML, you must update a setting so that you will be able to set up SCIM using the REST API. See "[AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/configuring-scim-provisioning-for-users#configuring-provisioning-for-other-identity-management-systems)."
{% data reusables.enterprise-accounts.access-enterprise-emu %}
{% data reusables.enterprise-accounts.identity-provider-tab %}
{% data reusables.enterprise-accounts.sso-configuration %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Using an **incognito or private browsing window**:

{% data reusables.enterprise-accounts.emu-password-reset-session %}

We strongly recommend **storing the credentials for the setup user** in your company's password management tool. Someone will need to sign in as this user to update authentication settings, migrate to another identity provider or authentication method, or use your enterprise's recovery codes.

## Create a {% data variables.product.pat_generic %}

{% data reusables.enterprise-accounts.emu-create-a-pat %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ By default, {% data variables.product.product_name %} does not display the sourc

You are responsible for meeting any legal obligations that accompany the viewing or storage of IP addresses displayed within your enterprise's audit log.

If you choose to display IP addresses for your enterprise account, the IP addresses will appear in both your enterprise's audit log and the audit log of every organization owned by your enterprise. Alternatively, you can enable the display of IP addresses in the audit log for individual organizations. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization)."
If you choose to display IP addresses for your enterprise account, IP addresses for **new and existing events** will appear in both your enterprise's audit log and the audit log of every organization owned by your enterprise. Alternatively, you can enable the display of IP addresses in the audit log for individual organizations. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization)."

You can display IP addresses in the audit log regardless of which authentication method you use for your enterprise on {% data variables.product.github %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ To learn more about the license data associated with your enterprise account and

## Viewing license usage on {% ifversion ghec %}{% data variables.product.prodname_ghe_cloud %}{% elsif ghes %}{% data variables.location.product_location %}{% endif %}

You can view the license usage for your enterprise and download a file with license details. If you're not seeing expected license counts in this report, it's possible that the subscriber’s assigned {% data variables.product.prodname_vs %} subscription email address and {% data variables.product.prodname_dotcom_the_website %} email address aren't exactly the same. For further information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise)."

{% ifversion ghec %}

You can view the license usage for your enterprise and download a file with license details. If you're not seeing expected license counts in this report, it's possible that the subscriber’s assigned {% data variables.product.prodname_vs %} subscription email address and {% data variables.product.prodname_dotcom_the_website %} email address aren't exactly the same. For further information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise)."

{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
Expand All @@ -54,11 +54,12 @@ You can view the license usage for your enterprise and download a file with lice
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
1. Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses.{% ifversion ghes %}
* To download the consumed license report as a JSON file, in the top right under "Quick links", choose **Export license usage**. For more information about reviewing the data in this report, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise)."
* If you have purchased {% data variables.product.prodname_GH_advanced_security %}, you can review your total {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} used as well as a per-organization breakdown of active committers. See "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise)."{% endif %}
1. Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses.

If you have purchased {% data variables.product.prodname_GH_advanced_security %}, you can review your total {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} used as well as a per-organization breakdown of active committers. See "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise)."

{% endif %}

{% ifversion ghec %}

## Viewing the last license sync date
Expand Down
Loading

0 comments on commit 8f68479

Please sign in to comment.