Как начать работать с Managed Service for GitLab

Чтобы начать работу с сервисом:

1. Создайте инстанс.
2. Настройте рабочее окружение.
3. Добавьте SSH-ключи в GitLab.
4. Начните работу с репозиторием.

Подробнее об отличиях Managed Service for GitLab от пользовательской инсталляции GitLab Community Edition читайте в разделе Преимущества сервиса перед пользовательской инсталляцией GitLab.

Перед началом работыПеред началом работы

Создайте инстансСоздайте инстанс

Настройте рабочее окружениеНастройте рабочее окружение

1. Активируйте инстанс Managed Service for GitLab:

   1. Перейдите по ссылке, полученной на электронную почту администратора после создания инстанса.
   2. Измените пароль администратора.
   3. Авторизуйтесь с помощью логина и пароля администратора.

2. (Опционально) Создайте группу, в которой будет размещен проект с репозиторием.

   Если есть несколько проектов, удобно объединять пользователей в группы. Это позволяет:

   • предоставлять права в определенные проекты каждой группе;
   • просматривать Issues и мерж-реквесты по группам;
   • просматривать аналитику по активности группы.

   Подробнее см. в документации GitLab.

3. Создайте пустой проект, в котором будет размещен репозиторий.

4. Создайте пользователей и добавьте их в группу или проект с ролью Maintainer или Owner.

   Добавить членов вашей команды в группу или проект можно, только создав для них аккаунты в GitLab.

Добавьте SSH-ключи в GitLabДобавьте SSH-ключи в GitLab

1. Создайте пару из открытого и закрытого SSH-ключей для аккаунта в GitLab:

   Linux/macOS

   Windows 10/11

   Windows 7/8

   1. Откройте терминал.

   2. Создайте новый ключ с помощью команды ssh-keygen:

      ssh-keygen -t ed25519 -C "<опциональный_комментарий>"
      

      Вы можете передать в параметре -C пустую строку, чтобы не добавлять комментарий, или не указывать параметр -C вообще — в таком случае будет добавлен комментарий по умолчанию.

      После выполнения команды вам будет предложено указать имя и путь к файлам с ключами, а также ввести пароль для закрытого ключа. Если задать только имя, пара ключей будет создана в текущей директории. Открытый ключ будет сохранен в файле с расширением .pub, закрытый ключ — в файле без расширения.

      По умолчанию команда предлагает сохранить ключ под именем id_ed25519 в директории /home/<имя_пользователя>/.ssh. Если в этой директории уже есть SSH-ключ с именем id_ed25519, вы можете случайно перезаписать его и потерять доступ к ресурсам, в которых он используется. Поэтому рекомендуется использовать уникальные имена для всех SSH-ключей.

   Если у вас еще не установлен OpenSSH, установите его по инструкции.

   1. Запустите cmd.exe или powershell.exe (предварительно обновите PowerShell).

   2. Создайте новый ключ с помощью команды ssh-keygen:

      ssh-keygen -t ed25519 -C "<опциональный_комментарий>"
      

      Вы можете передать в параметре -C пустую строку, чтобы не добавлять комментарий, или не указывать параметр -C вообще — в таком случае будет добавлен комментарий по умолчанию.

      После выполнения команды вам будет предложено указать имя и путь к файлам с ключами, а также ввести пароль для закрытого ключа. Если задать только имя, пара ключей будет создана в текущей директории. Открытый ключ будет сохранен в файле с расширением .pub, закрытый ключ — в файле без расширения.

      По умолчанию команда предлагает сохранить ключ под именем id_ed25519 в папку C:\Users\<имя_пользователя>/.ssh. Если в этой директории уже есть SSH-ключ с именем id_ed25519, вы можете случайно перезаписать его и потерять доступ к ресурсам, в которых он используется. Поэтому рекомендуется использовать уникальные имена для всех SSH-ключей.

   Создайте ключи с помощью приложения PuTTY:

   1. Скачайте и установите PuTTY.

   2. Добавьте папку с PuTTY в переменную PATH:

      1. Нажмите кнопку Пуск и в строке поиска Windows введите Изменение системных переменных среды.
      2. Справа снизу нажмите кнопку Переменные среды....
      3. В открывшемся окне найдите параметр PATH и нажмите Изменить.
      4. Добавьте путь к папке в список.
      5. Нажмите кнопку ОК.

   3. Запустите приложение PuTTYgen.

   4. В качестве типа генерируемой пары выберите EdDSA. Нажмите Generate и поводите курсором в поле выше до тех пор, пока не закончится создание ключа.

      

   5. В поле Key passphrase введите надежный пароль. Повторно введите его в поле ниже.

   6. Нажмите кнопку Save private key и сохраните закрытый ключ. Никому не сообщайте ключевую фразу от него.

   7. Нажмите кнопку Save public key и сохраните открытый ключ в файле <имя_ключа>.pub.

2. Запустите SSH-агент:

   Linux/MacOS

   Windows

   1. Выполните команду:

      ssh-agent -s
      

   2. Чтобы SSH-агент запускался при входе в систему, в файл ~/.profile добавьте команду запуска:

      ssh-agent -s
      

   1. Откройте контекстное меню кнопки Пуск.
   2. Выберите пункт Управление компьютером.
   3. Перейдите в раздел Службы и приложения → Службы.
   4. Откройте контекстное меню службы SSH agent и выберите пункт Свойства.
   5. На вкладке Главное измените тип запуска с Выключена на Автоматически.
   6. Нажмите кнопку OK и запустите службу.

3. Добавьте ключ в SSH-агент:

   ssh-add <путь_к_закрытому_ключу>
   

4. Присвойте публичный SSH-ключ аккаунту в GitLab.

5. Проверьте, что вы можете подключиться к GitLab:

   ssh -T git@<домен_инстанса_GitLab>
   

   Пример:

   ssh -T git@example.gitlab.yandexcloud.net
   

   Если вы подключаетесь в первый раз, отобразится подобное сообщение:

   The authenticity of host 'gitlab.example.com (35.231.145.151)' can't be established.
   ECDSA key fingerprint is SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw.
   Are you sure you want to continue connecting (yes/no)? yes
   Warning: Permanently added 'gitlab.example.com' (ECDSA) to the list of known hosts.
   

   Введите yes и нажмите Enter.

   Если вы подключаетесь не в первый раз, в случае успеха появится сообщение:

   Welcome to GitLab, @<логин>!
   

   В случае ошибки запустите подключение в режиме Verbose, чтобы получить логи:

   ssh -Tvvv git@<домен_инстанса_GitLab>
   

Попросите каждого участника вашей группы или проекта создать пару SSH-ключей таким образом и присвоить публичный ключ своему аккаунту в GitLab.

Начните работу с репозиториемНачните работу с репозиторием

Чтобы начать работу с локальной копией вашего репозитория от имени созданного аккаунта, выполните следующие действия на локальном компьютере:

1. Установите клиент Git.

2. Клонируйте репозиторий по протоколу SSH.

   Что делать в случае ошибки Permission denied (publickey)

   При клонировании может возникнуть ошибка:

   Cloning into '<название_проекта>'...
   git@<домен_инстанса_GitLab>: Permission denied (publickey).
   fatal: Could not read from remote repository.
   
   Please make sure you have the correct access rights
   and the repository exists.
   

   Если вы получили такую ошибку:

   1. Создайте и откройте конфигурационный файл для настройки SSH-ключей:

      nano ~/.ssh/config
      

   2. Добавьте в него содержимое:

      Host <домен_инстанса_GitLab>
         IdentityFile <путь_к_закрытому_ключу>
      

      В параметре IdentityFile укажите абсолютный путь к закрытому ключу, который вы создали для проекта GitLab.

   3. Сохраните файл.

   4. Снова склонируйте репозиторий по SSH.

3. Перейдите в каталог с репозиторием:

   cd <имя_проекта>
   

4. Внесите изменения в файлы репозитория.

5. Проиндексируйте и примените изменения в локальном репозитории:

   git add . && git commit -m "<название_коммита>"
   

6. Отправьте изменения в удаленный репозиторий:

   git push origin main