Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Чарт, хранящийся в git-репозитории

Чарт Helm не обязательно берётся из реестра чартов. В этом примере используется чарт, который находится в git-репозитории, — собственный пример чарта hello-world проекта Helm, — и он собирается в манифесты Kubernetes.

Aggregate разработчика ничего об этом не говорит. В нём объявлен один core/compute/server, а то, откуда берётся упаковка этого сервера, решается в Recipe и связывается в Manifest.

Блок источника

catalog/recipe/helm/hello-world-git/1.0.0/recipe.yaml
source:
kind: git-repository
url: https://github.com/helm/examples.git
ref: hello-world-0.1.0
module_subdir: charts/hello-world

Три координаты, и каждая отвечает на свой вопрос:

  • url — репозиторий для клонирования. Принимаются https://, ssh:// и git://. К приватному репозиторию обращаются по SSH через SSH-агент или по HTTPS с записью для его хоста в вашем файле netrc — machine github.com login <user> password <token>. Учётные данные, записанные в сам URL, отклоняются, как описано в разделе Аутентификация.
  • ref — ссылка, по которой читается репозиторий: тег, ветка или коммит. Это то имя, которое дали авторы самого репозитория, и оно не всегда является просто версией — здесь тег содержит ещё и имя чарта.
  • module_subdir — каталог внутри репозитория, который является чартом. Репозиторий содержит чарт по этому пути, а не является чартом сам, и каталог входит в то, что делает артефакт отдельным: два каталога одного репозитория на одном коммите — это два артефакта, а не один.

Вид источника задаёт транспорт и расположение, а не формат. Один и тот же вид загружает чарт, модуль Terraform или любой другой каталог файлов; что содержит каталог — дело потребляющего провайдера.

Что записывает lock-файл

Только коммит указывает на содержимое, которое не может измениться без вашего ведома. Тег или ветка — это имя, которое репозиторий может перенаправить на другой коммит, поэтому aggrega pull разрешает ссылку и записывает и то, и другое — ссылку, которую вы написали, и коммит, в который она разрешилась:

# release-chart.lock
source_artifacts:
- kind: git-repository
url: https://github.com/helm/examples.git
module_subdir: charts/hello-world
pinned_version: f3dc419e558e6ccebce2ed447384e5d2e11de2f9
digest: sha256:2bee62cfc2efccc61d8e17efeb72f9f77ad7bd87f3ea4e50b1e4219c8d5a2c78
mediatype: application/gzip
referenced_by:
- entity: recipe
uri: helm/hello-world-git:1.0.0
field: spec.source
requested_ref: hello-world-0.1.0

Обе половины нужны. Коммит — это то, что загружает сборка, поэтому сборка воспроизводима. Ссылка — это то, по чему сборка ищет запись, и именно это позволяет вам и дальше писать ref: hello-world-0.1.0 в Recipe и при этом получать точно тот коммит, на который указывал тег, когда был записан lock-файл.

Создание примера

Этот пример можно собрать командами ниже или поручить сборку вашему ИИ-ассистенту.

Запишите пример в новую папку, названную по его имени:

Terminal window
aggrega scaffold --example chart-from-git-repository

Затем она выводит команды, которые нужно выполнить дальше. Первая переходит в новую папку:

Terminal window
cd chart-from-git-repository

Сборка

Terminal window
aggrega build --release release-chart.yaml --auto-pull

В этом примере два релиза, поэтому собираемый указывается явно. Первой сборке нужен lock-файл, поэтому здесь передаётся --auto-pull; однократный запуск aggrega pull --release release-chart.yaml заранее делает то же самое и позволяет всем последующим сборкам выполняться без флага.

Отрисованный Deployment содержит значения, переданные Release, сопоставленные с собственными именами значений чарта:

dist/app/helm/web-deployment-web-hello-world.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: web-hello-world
[… omitted: the chart's own labels, and the labels and annotations every rendered document carries]
spec:
replicas: 2
[… omitted: the selector and the pod template's own labels]
spec:
serviceAccountName: web-hello-world
securityContext: {}
containers:
- name: hello-world
securityContext: {}
image: "nginx:1.27.3"
imagePullPolicy: IfNotPresent
[… omitted: the container port and the two probes]

Каждая сборка выводит одно предупреждение:

warning: node "web": .infra key "compute" is read by no template in recipe "hello-world-git" — correct the spelling, or remove the key

Оно точно, и его стоит прочитать, а не заглушать. Component core/compute/server предлагает параметр размера по CPU и памяти; этот конкретный чарт не предоставляет для него значений, поэтому Recipe ничего туда не сопоставляет. Recipe с источником сопоставляет то, что действительно принимает его чарт, а компилятор сообщает о значении, которое никуда не попало, вместо того чтобы делать вид, что оно применено.

С ИИ-ассистентом

ИИ-ассистент, настроенный с инструментами Aggrega, может сделать то же самое: вставьте в него этот промпт.

Используйте только инструменты Aggrega и не создавайте папки сами. Если в папке рабочего пространства ещё нет папки `chart-from-git-repository`, вызовите один раз инструмент `scaffold`, задав для `example` значение `chart-from-git-repository` и не задавая `dir`: он запишет пример в новую папку `chart-from-git-repository`. Затем вызовите инструмент `build`, задав для `workspace_root` значение `chart-from-git-repository`, для `release` — `release-chart.yaml`, для `auto_pull` — true и для `write` — true. Сообщите мне, какие файлы записала сборка; они находятся в `chart-from-git-repository/dist/`.

Когда ссылка смещается

Тег в репозитории можно перенаправить. Когда это происходит, следующий обычный aggrega pull обнаруживает, что ссылка разрешается не в тот коммит, который он записал, и останавливается, а не принимает его:

# aggrega pull --release release-chart.yaml
#
# [E0130]
# lockfile: out of date; it no longer matches what its Release resolves to
# ---
# source-artifact kind=git-repository url=https://github.com/helm/examples.git
# module_subdir=charts/hello-world: reference "hello-world-0.1.0" moved — the
# lockfile pins 03f4a18d3c2b77b7ecd91d0324a95910d4f04152, and it now resolves to
# f3dc419e558e6ccebce2ed447384e5d2e11de2f9; adopt where it now points with
# `aggrega pull --upgrade --release <release>`

В сообщении названы оба коммита, поэтому вы видите, что именно сместилось, прежде чем принимать решение. Lock-файл остаётся как был — остановка происходит до любой записи, — а принятие нового коммита является осознанным действием:

Terminal window
aggrega pull --upgrade --pin-sources --release release-chart.yaml

Сместившаяся ссылка — именно тот случай, для которого предназначен --upgrade: обычный pull удерживает коммит, записанный в lock-файле, и только обновление принимает то, куда ссылка указывает теперь. --upgrade без аргументов сбрасывает все записанные закрепления, поэтому сначала запрашивает подтверждение. Нужен также --pin-sources, потому что этот Recipe также записывает коммит своего источника в entity.lock рядом с собой: обновление переписывает это закрепление на новый коммит, а без флага pull останавливается на lock-файле и указывает на aggrega pin. Закоммитьте переписанный entity.lock вместе с Recipe.

Правка, сделанная в этом рабочем пространстве, например в Aggregate или Release, — это расхождение другого рода: следующая сборка сообщает о нём, а обычный aggrega pull --release release-chart.yaml его устраняет.

Закрепление коммита в ref: вместо тега — другой способ получить ту же гарантию ценой координаты, которую не может прочитать человек.

Контрольный релиз

release-negative.yaml должен завершаться ошибкой, и он здесь потому, что путь загрузки, проверенный только в успешном сценарии, ничего не говорит о своих защитах. Он развёртывает тот же Aggregate через manifest-negative.yaml, который связывает Recipe, идентичный рабочему, за исключением ссылки, — он указывает тег, которого в репозитории нет:

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# exits non-zero
# [E0137]
# auto-pull: resolving the source of each Recipe and FeatureRecipe the Release
# uses: resolve: resolve source for recipe
# "helm/hello-world-git-missing-ref:1.0.0": sourceresolver: kind=git-repository
# url=https://github.com/helm/examples.git version=: oci: artifact not found at
# remote source (cause: reference not found)
[… omitted: the rest of that line, a remediation naming the URL and version to check]

Репозиторий доступен, и клонирование проходит успешно; просто такой ссылки в нём нет, поэтому нет коммита для закрепления и нечего архивировать.

Что этому примеру нужно от сети

В отличие от большинства рабочих пространств здесь, это при первой сборке клонирует настоящий репозиторий, поэтому такой сборке нужен исходящий доступ к хосту, указанному в url. Когда lock-файл и кэш разрешения уже существуют, последующие сборки читают из кэша и выполняются вовсе без сети — aggrega build --release release-chart.yaml --offline воспроизводит те же байты.