Разработка

В этом документе объясняется, как настроить среду разработки, чтобы вы могли приступить к работе над Knative Eventing. Также ознакомьтесь с рабочим процессом разработки и документацией по тестированию.

Начало работы

1. Настройте Knative Serving.
2. Настройте Knative Eventing.
3. Создайте и проверьте репозиторий на предмет ошибок.

После выполнения этих требований вы можете установить исходные коды проекта!

Перед отправкой PR также ознакомьтесь с CONTRIBUTING.md.

Требования

У вас должен быть запущен основной компонент Knative Serving в вашем кластере.

У вас должен быть запущен Knative Eventing в вашем кластере.

У вас должно быть установлено ko.

Проверка вашего форка

Инструменты Go требуют, чтобы вы клонировали репозиторий в каталог src/knative.dev/eventing-contrib в вашей переменной среды GOPATH.

Чтобы проверить этот репозиторий:

1. Создайте свой собственный форк этого репозитория.
2. Клонируйте его на свой компьютер:

mkdir -p ${GOPATH}/src/knative.dev
cd ${GOPATH}/src/knative.dev
git clone git@github.com:${YOUR_GITHUB_USERNAME}/eventing-contrib.git
cd eventing-contrib
git remote add upstream git@github.com:knative/eventing-contrib.git
git remote set-url --push upstream no_push

Добавление удалённого источника upstream позволяет вам легко синхронизировать ваш форк.

Как только вы достигнете этой точки, вы будете готовы выполнить полную сборку и развёртывание следующим образом.

Установка исходных кодов

После настройки среды разработки (#Начало работы) установите любой из источников: Github Source, AWS SQS Source, Camel Source, Kafka Source с помощью команды:

ko apply -f <source_name>/config  # например, github/config

Эти команды являются идемпотентными, поэтому вы можете запускать их в любое время для обновления вашего развёртывания.

Если вы применили GitHub Source, вы можете увидеть, что всё работает, выполнив команду:

$ kubectl -n knative-sources get pods
NAME                          READY     STATUS    RESTARTS   AGE
github-controller-manager-0   1/1       Running   0          2h

Вы можете получить доступ к журналам менеджера событий Github с помощью команды:

kubectl -n knative-sources logs \
    $(kubectl \
        -n knative-sources \
        get pods \
        -l control-plane=github-controller-manager \
        -o name \
    )

См. camel/source/samples/README.md, kafka/source/README.md для получения инструкций по установке Camel Source и Kafka Source.

Итерация

По мере внесения изменений в кодовую базу:

• Если вы меняете зависимости пакета (включая добавление внешних зависимостей), то вы должны запустить ./hack/update-deps.sh.
• Если вы изменяете определение типа (<source_name>/pkg/apis/), то вы должны запустить ./hack/update-codegen.sh. Это также запускает ./hack/update-deps.sh.

Обе команды идемпотентны, и мы ожидаем, что запуск их в ветке master не приведёт к различиям.

Чтобы убедиться, что ваш сгенерированный код соответствует новому определению типа, вы можете запустить ./hack/verify-codegen.sh. На OSX вам потребуется GNU diff версии 3.7, который можно установить из brew с помощью brew install diffutils.

Чтобы проверить, проходит ли сборка и тесты, см. документацию по тестам (#Тесты) или просто запустите ./test/presubmit-tests.sh.

Как только информация о кодегене и зависимостях будет правильной, повторно разверните проект, используя ту же команду ko apply, которую вы использовали для установки источника.

Или вы можете полностью удалить его и начать заново.

Тесты

Запуск тестов по мере внесения изменений в код довольно прост. См. документацию по тестам.

Очистка

Вы можете удалить Knative Sources с помощью команды: ```shell ko delete -f <source_name>/config/

<!--
TODO(#15): Add default telemetry.
## Telemetry

See [telemetry documentation](./docs/telemetry.md).
-->