docs: добавил инструкцию по деплою в README и tests-deploy

This commit is contained in:
Naeel
2026-04-13 09:33:30 +03:00
parent 3cf81a1e01
commit 6cad557dde
2 changed files with 104 additions and 26 deletions
+45 -11
View File
@@ -4,6 +4,39 @@
Сервис предназначен для работы через стандартные AWS SDK и AWS CLI: в обычном клиентском коде меняется только endpoint.
## Быстрый старт — деплой
### 1. Заполнить параметры
Отредактировать `deploy/values.yaml`:
- Redis хост и пароль
- Ingress домен (для доступа извне)
- PostgreSQL credentials (опционально, для биллинга)
### 2. Деплоить
```bash
kubectl create namespace shared-sqs
helm install shared-sqs ./deploy -n shared-sqs
```
### 3. Проверить что работает
```bash
# Дождаться pod ready (1/1)
kubectl -n shared-sqs get pod -w
# Запустить тесты
cd tests-deploy
bash run.sh
```
**Результат:** PASS=7 FAIL=0 ✅
Полная инструкция с примерами параметров → [tests-deploy/README.md](tests-deploy/README.md)
---
## Демо-стенд
| | |
@@ -20,7 +53,7 @@ Demo token и demo credentials предназначены для ознаком
Важно для demo stand:
- demo tenant общий, поэтому очереди и сообщения в нём могут меняться во время просмотра;
- `QueueUrl` может выглядеть как внутренний адрес сервиса, это нормально для данного стенда: передавайте его обратно как есть и продолжайте использовать `--endpoint-url https://qu.kube5s.ru`.
- \`QueueUrl\` может выглядеть как внутренний адрес сервиса, это нормально для данного стенда: передавайте его обратно как есть и продолжайте использовать \`--endpoint-url https://qu.kube5s.ru\`.
## Что поддерживается
@@ -52,8 +85,8 @@ shared-SQS покрывает 17 SQS-операций:
Для быстрого демо доступны оба публичных входа:
- Web UI: используйте `demo-ui-shared-sqs-ngcloud-2026`
- AWS CLI / SDK: используйте demo `Access Key / Secret Key`
- Web UI: используйте \`demo-ui-shared-sqs-ngcloud-2026\`
- AWS CLI / SDK: используйте demo \`Access Key / Secret Key\`
Для ознакомительного доступа можно использовать demo credentials:
@@ -66,23 +99,23 @@ ENDPOINT="--endpoint-url https://qu.kube5s.ru"
Для входа в Web UI:
1. Откройте `https://qu.kube5s.ru/ui/`
2. Вставьте `demo-ui-shared-sqs-ngcloud-2026`
1. Откройте \`https://qu.kube5s.ru/ui/\`
2. Вставьте \`demo-ui-shared-sqs-ngcloud-2026\`
3. После входа вы попадёте в demo tenant и увидите его очереди и сообщения
### 2. Получить свои credentials через Web UI
Если нужен полноценный доступ к своим очередям и сообщениям, используйте Web UI:
1. Откройте `https://qu.kube5s.ru/ui/`
2. В поле входа вставьте свой `API Token (nubes JWT)`
1. Откройте \`https://qu.kube5s.ru/ui/\`
2. В поле входа вставьте свой \`API Token (nubes JWT)\`
3. Этот токен пользователь получает в панели управления облаком Nubes
4. После успешного входа shared-SQS автоматически создаёт tenant и показывает `Access Key` и `Secret Key`
5. Эти `Access Key / Secret Key` дальше используются в AWS CLI, boto3, AWS SDK for JavaScript и других клиентах
4. После успешного входа shared-SQS автоматически создаёт tenant и показывает \`Access Key\` и \`Secret Key\`
5. Эти \`Access Key / Secret Key\` дальше используются в AWS CLI, boto3, AWS SDK for JavaScript и других клиентах
Важно:
- `Secret Key` показывается только один раз, его нужно сохранить
- для AWS CLI и SDK нужен не UI token, а именно выданные сервисом `Access Key / Secret Key`
- \`Secret Key\` показывается только один раз, его нужно сохранить
- для AWS CLI и SDK нужен не UI token, а именно выданные сервисом \`Access Key / Secret Key\`
Примеры ниже можно запускать либо с demo credentials, либо со своими tenant credentials.
@@ -97,6 +130,7 @@ ENDPOINT="--endpoint-url https://qu.kube5s.ru"
### Создать очередь
```bash
```bash
aws sqs create-queue --queue-name demo-queue $ENDPOINT
```