Skip to main content

Restricting access to machine types

You can set constraints on the types of machines users can choose when they create codespaces in your organization.

Who can use this feature

To manage access to machine types for the repositories in an organization, you must be an owner of the organization.

GitHub Codespaces está disponible para las organizaciones que usen GitHub Team o GitHub Enterprise Cloud. GitHub Codespaces también está disponible como versión beta limitada para usuarios individuales en los planes GitHub Free y GitHub Pro. Para más información, vea "Productos de GitHub".

Overview

Typically, when you create a codespace you are offered a choice of specifications for the machine that will run your codespace. You can choose the machine type that best suits your needs. For more information, see "Creating a codespace." If you pay for using GitHub Codespaces then your choice of machine type will affect how much your are billed. For more information about pricing, see "About billing for GitHub Codespaces."

As an organization owner, you may want to configure constraints on the types of machine that are available. For example, if the work in your organization doesn't require significant compute power or storage space, you can remove the highly resourced machines from the list of options that people can choose from. You do this by defining one or more policies in the GitHub Codespaces settings for your organization.

Behavior when you set a machine type constraint

If there are existing codespaces that no longer conform to a policy you have defined, these codespaces will continue to operate until they are stopped or time out. When the user attempts to resume the codespace they are shown a message telling them that the currenly selected machine type is no longer allowed for this organization and prompting them to choose an alternative machine type.

If you remove higher specification machine types that are required by the GitHub Codespaces configuration for an individual repository in your organization, then it won't be possible to create a codespace for that repository. When someone attempts to create a codespace they will see a message telling them that there are no valid machine types available that meet the requirements of the repository's GitHub Codespaces configuration.

Note: Anyone who can edit the devcontainer.json configuration file in a repository can set a minimum specification for machines that can be used for codespaces for that repository. For more information, see "Setting a minimum specification for codespace machines."

If setting a policy for machine types prevents people from using GitHub Codespaces for a particular repository there are two options:

  • You can adjust your policies to specifically remove the restrictions from the affected repository.
  • Anyone who has a codespace that they can no longer access, because of the new policy, can export their codespace to a branch. This branch will contain all of their changes from the codespace. They can then open a new codespace on this branch with a compliant machine type or work on this branch locally. For more information, see "Exporting changes to a branch."

Setting organization-wide and repository-specific policies

When you create a policy you choose whether it applies to all repositories in your organization, or only to specified repositories. If you set an organization-wide policy then any policies you set for individual repositories must fall within the restriction set at the organization level. Adding policies makes the choice of machine more, not less, restrictive.

For example, you could create an organization-wide policy that restricts the machine types to either 2 or 4 cores. You can then set a policy for Repository A that restricts it to just 2-core machines. Setting a policy for Repository A that restricted it to machines with 2, 4, or 8 cores would result in a choice of 2-core and 4-core machines only, because the organization-wide policy prevents access to 8-core machines.

If you add an organization-wide policy, you should set it to the largest choice of machine types that will be available for any repository in your organization. You can then add repository-specific policies to further restrict the choice.

Nota: Las políticas de organización que definas para Codespaces solo se aplican a los codespaces para los que se facturará la organización. Si un usuario individual crea un codespace para un repositorio de tu organización y la organización no se factura, dicho codespace no estará enlazado por estas políticas. Para obtener información sobre cómo elegir quién puede crear codespaces que se facturan a tu organización, consulta "Habilitar GitHub Codespaces para tu organización".

Adding a policy to limit the available machine types

  1. En la esquina superior derecha de GitHub.com, haga clic en la foto de perfil y luego en Your organizations. Opción Your organizations (Sus organizaciones) en el menú del perfil

  2. Junto a la organización, haga clic en Settings. El botón de configuración

  3. En la sección "Código, planificación y automatización" de la barra lateral, seleccione Codespaces y, después, haga clic en Directivas.

  4. En la página "Directivas de codespace", haga clic en Crear directiva.

  5. Ingresa un nombre para tu política nueva.

  6. Click Add constraint and choose Machine types.

    Add a constraint for machine types

  7. Click to edit the constraint, then clear the selection of any machine types that you don't want to be available.

    Edit the machine type constraint

  8. En el área de "Cambiar destino de la política", haz clic en el botón desplegable.

  9. Elija All repositories o Selected repositories para determinar a qué repositorios se aplicará esta directiva.

  10. Si ha elegido Selected repositories:

    1. Haga clic en .

      Editar los ajustes para la política

    2. Selecciona los repositorios a los cuales quieres que aplique esta política.

    3. En la parte inferior de la lista de repositorios, haga clic en Select repositories.

      Selecciona los repositorios para esta política

  11. If you want to add another constraint to the policy, click Add constraint and choose another constraint. For information about other constraints, see "Restricting the visibility of forwarded ports," "Restricting the idle timeout period," and "Restricting the retention period for codespaces."

  12. After you've finished adding constraints to your policy, click Save.

Editing a policy

You can edit an existing policy. For example, you may want to add or remove constraints to or from a policy.

  1. Display the "Codespace policies" page. For more information, see "Adding a policy to limit the available machine types."
  2. Click the name of the policy you want to edit.
  3. Make the required changes then click Save.

Deleting a policy

  1. Display the "Codespace policies" page. For more information, see "Adding a policy to limit the available machine types."

  2. Click the delete button to the right of the policy you want to delete.

    The delete button for a policy

Further reading