Skip to content

Commit

Permalink
Правки из комментария в тикете. Остались еще правки.
Browse files Browse the repository at this point in the history
  • Loading branch information
@parinovK
parinovK committed Jul 11, 2024
1 parent 0dc7ce3 commit ee50cad
Showing 1 changed file with 49 additions and 54 deletions.
103 changes: 49 additions & 54 deletions ru/personal-domain-ya-cloud.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,44 +9,41 @@
1. Откройте [Быстрый старт](https://diplodoc.com/quickstart/).
1. Авторизуйтесь в Github, кликнув по зеленому прямоугольнику с логотипом Github.

{% note alert %}
{% note alert %}

Если сервис выдаст ошибку «Could not get github state back» - вернитесь на страницу [быстрого старта](https://diplodoc.com/quickstart/).
Если сервис выдаст ошибку «Could not get github state back» - обновите текущую страницу.
Чтобы обновить страницу нажмите сочетание клавиш **CTRL + F5**.

{% endnote %}
{% endnote %}

1. В шаге №2 нажмите **Создать** и создайте репозиторий в Github. В результате будет создан проект с именем «diplodoc-example», предзаполненный командой Diplodoc.
1. В шаге №3 нажмите **Создать** и создайте проект в Diplodoc.
1. Готово. В результате успешного выполнения пошаговой инструкции вы получите сообщение:
1. В результате успешного выполнения пошаговой инструкции вы получите сообщение:

```
Ключи от каталога с документацией в S3.
Идентификатор ключа:
Здесь-будет-указан-идентификатор-ключа
Секретный ключ:
Здесь-будет-указан-секретный-ключ
Сохраните идентификатор и ключ. После закрытия диалога значение ключа будет недоступно. Ключ будет добавлен в созданный репозиторий автоматически.
```

{% note alert %}
```
Ключи от каталога с документацией в S3.
Идентификатор ключа:
YCAJEmTm6zlPbQ14F8pLv2xgV
Секретный ключ:
YCO6ctaYJxgdXU5qOaq73ucAfm3BfAc6gZW-1_fk
Дождитесь завершения релиза, проект будет доступен по ссылке.
Сохраните идентификатор и ключ. После закрытия диалога значение ключа будет недоступно. Ключ будет добавлен в созданный репозиторий автоматически.
```
{% endnote %}
1. Дождитесь завершения релиза, проект будет доступен по ссылке в шаге №3 на странице [Быстрого старта](https://diplodoc.com/quickstart).
## Привязка домена к Yandex Cloud
Для привязки домена к Yandex Cloud:
1. Зарегистрируйте домен (в этом вам поможет любой [доменный регистратор](https://yandex.ru/search/?text=доменнный+регистратор)).
1. Зарегистрируйте домен (для этого используйте [доменный регистратор](https://yandex.ru/search/?text=доменнный+регистратор)).
1. Авторизуйтесь или создайте аккаунт в [Yandex Cloud](https://yandex.cloud/).
{% note warning %}
{% note warning %}
На странице [Биллинг](https://billing.yandex.cloud/accounts) убедитесь, что у вас подключен [платежный аккаунт](https://yandex.cloud/ru/docs/billing/concepts/billing-account) и находится в статусе `ACTIVE` или `TRIAL_ACTIVE`. Если платежного аккаунта нет, [создайте его](https://yandex.cloud/ru/docs/billing/quickstart/#create_billing_account).
На странице [Биллинг](https://billing.yandex.cloud/accounts) убедитесь, что у вас подключен [платежный аккаунт](https://yandex.cloud/ru/docs/billing/concepts/billing-account) и находится в статусе `ACTIVE` или `TRIAL_ACTIVE`. Если платежного аккаунта нет, [создайте его](https://yandex.cloud/ru/docs/billing/quickstart/#create_billing_account).
{% endnote %}
{% endnote %}
1. Перейдите в [консоль](https://console.yandex.cloud/folders/).
1. Откройте **Все сервисы** → **API Gateway**.
Expand All @@ -59,14 +56,15 @@
1. Нажмите кнопку **Создать API-шлюз**.
1. Заполните поля **Имя\*** и описание.
1. Заполните поля **Имя\*** и описание. Поле со звездочкой обязательно для заполнения.
1. В поле **Сеть** выберите `default` или свой вариант.
1. Заполните поле **Спецификация**, используя шаблон спецификации OpenAPI:
1. Заполните поле **Спецификация**, используя шаблон спецификации OpenAPI.
{% cut "Спецификация OpenAPI" %}
{% cut "Шаблон спецификации OpenAPI" %}
```
openapi: 3.0.0
info:
title: Proxy Example
Expand All @@ -93,32 +91,30 @@
required: false
schema:
type: string
```
{% endcut %}
#|
|| Параметр | Описание параметра ||
|| `servers` | Содержит следующие вложенные параметры:
- первый `url` параметр — оставьте по умолчанию,
- второй `url`параметр — укажите свой домен. ||
|| `paths` | Содержит правило и позволяет настраивать путь с помощью вложенного параметра `/путь/{path+}:`, который указывает на каком урле должна располагаться документация. ||
|| `get` | Вложенное в `paths:` правило, которое объясняет как путь должен обрабатываться. В шаблоне правило обрабатывает все get-запросы. ||
|| `headers` | Параметр содержит служебные заголовки. ||
|#
#|
|| Параметр | Описание параметра ||
|| `servers` | Содержит следующие вложенные параметры:
- первый `url` параметр — оставьте по умолчанию,
- второй `url`параметр — укажите свой домен. ||
|| `paths` | Содержит правило и позволяет настраивать путь с помощью вложенного параметра `/путь/{path+}:`, который указывает на каком урле должна располагаться документация. ||
|| `get` | Вложенное в `paths:` правило, которое объясняет как путь должен обрабатываться. В шаблоне правило обрабатывает все get-запросы. ||
|| `headers` | Параметр содержит служебные заголовки. ||
|#
{% note warning %}
{% note warning %}
Если нужно размещаться в корне домена, замените ключ параметра `x-docs-proxy-base` на `' '`, а также у параметра `paths` уберите `/путь`, чтобы осталось `/{path+}:`.
Если нужно размещаться в корне домена, замените ключ параметра `x-docs-proxy-base` на `' '`, а также у параметра `paths` уберите `/путь`, чтобы осталось `/{path+}:`.
{% endnote %}
{% endnote %}
{% endcut %}
1. Нажмите **Создать**.
1. Если платежный аккаунт не привязан, нажмите **Привязать**.
1. Готово. В результате должен появиться API-шлюз со статусом `active`.

\* Поля со звездочкой обязательны для заполнения.

На данном этапе домен еще не подключен. Перед подключением домена к Yandex Cloud, нужно [создать новый или загрузить личный сертификат](#cert-creating).
1. В результате должен появиться API-шлюз со статусом `active`.
1. [Создайте новый или загрузите личный сертификат]((#cert-creating)).
### Создание/загрузка сертификата {#cert-creating}
Expand All @@ -129,31 +125,30 @@
1. Нажмите **Создать сертификат**.
1. На странице выберите **Добавить сертификат** → **Сертификат от Let's Encrypt**.
{% note info %}
{% note info %}
Если у вас уже есть сертификат, который зарегистрирован во внешнем сервисе, вы можете использовать его, для этого в выпадающем меню выберите **Пользовательский сертификат**.
Если у вас уже есть сертификат, который зарегистрирован во внешнем сервисе, вы можете использовать его, для этого в выпадающем меню выберите **Пользовательский сертификат**.
{% endnote %}
{% endnote %}
1. Заполните поля **Имя\*** и описание.
1. Укажите **Домены\***, для которых необходимо добавить сертификат.
1. Заполните поля **Имя\*** и описание. Поле со звездочкой обязательно для заполнения.
1. Укажите **Домены\***, для которых необходимо добавить сертификат. Поле обязательно для заполнения.
1. Выберите в поле **Тип проверки** — DNS.
1. Готово. Созданный сертификат будет ожидать подтверждения со статусом `Validating`.
1. Созданный сертификат будет ожидать подтверждения со статусом `Validating`.
1. [Подтвердите](#cert-validating), что вы являетесь владельцем домена.
\* Поля со звездочкой обязательны для заполнения.

### Подтверждение сертификата {#cert-validating}
Для подтверждения прав на владение доменом:
1. Перейдите в [консоль](https://console.yandex.cloud/folders/).
1. Откройте **Все сервисы** → **Certificate Manager**.
1. Выберите созданный или добавленный сертификат.
1. Подтвердите права на владение доменом, используя один из способов.
1. Готово. Права на владение домена подтверждены.
1. Подтвердите права на владение доменом, используя один из предложенных способов.
1. Права на владение домена подтверждены.
1. [Подключите домен](#connect-domain).
### Подключение домена
### Подключение домена {#connect-domain}
Для завершения привязки домена к Yandex Cloud:
Expand All @@ -163,4 +158,4 @@
1. Выберите созданный сертификат.
1. Укажите домен.
1. Нажмите **Подключить**.
1. Готово. Проксирование на личный домен работает.
1. Настройка проксирования на личный домен завершена.

0 comments on commit ee50cad

Please sign in to comment.