Эта страница переведена с помощью Cloud Translation API.

Набор инструментов Cloud Foundation 101

1. Введение в CFT 101

Последнее обновление: 11 февраля 2022 г.

Что такое набор инструментов Cloud Foundation?

По сути, CFT предоставляет передовые шаблоны для быстрого начала работы с Google Cloud Platform. Из этого руководства вы узнаете, как внести свой вклад в набор инструментов Cloud Foundation.

Что вам понадобится

Аккаунт GitHub.
На вашем компьютере установлен Docker или используйте Cloud Shell ( установка Mac , установка Windows l)
Редактор кода для редактирования кода (пример: код Visual Studio )
Базовое знание Git и GitHub.
Некоторый опыт работы с Terraform и инфраструктурой как кодом.
Разрешение на предоставление роли создателя проекта сервисному аккаунту.
Облачная организация Google, тестовая папка и платежный аккаунт.

Что ты построишь

В этой лаборатории кода вы узнаете, как внести свой вклад в Cloud Foundation Toolkit (CFT).

Вы будете:

Настройте среду разработки для участия в CFT
Добавьте функцию в модуль CFT
Добавить тесты для добавленной функции
Выполнить интеграционные тесты в ЦФТ
Выполнить lint-тесты
Зафиксируйте код на GitHub и отправьте запрос на включение (PR)

Вы выполните все вышеперечисленные шаги, добавив новую функцию в модуль Google Cloud Storage CFT . Вы добавите метку под названием "silly_label" , которая будет автоматически добавлена ко всем сегментам, созданным с помощью модуля GCS CFT. Вы также сможете писать тесты для проверки вашей функции и обеспечения сквозной интеграции.

2. Настройка среды разработки

Если вы хотите, вы можете использовать Cloud Shell для своих целей разработки. Если вы не хотите использовать Cloud Shell для участия в CFT, вы можете настроить среду разработки на своем компьютере.

Настройте Git

GitHub основан на системе контроля версий с открытым исходным кодом (VCS) под названием Git. Git отвечает за все, что связано с GitHub и происходит локально на вашем компьютере или в Cloud Shell.

При использовании Cloud Shell вам не нужно устанавливать git, поскольку он уже установлен.

$ git --version
# This will display the git version on the Cloud Shell.

Если вы настраиваете среду разработки на своем компьютере, вам необходимо установить Git.

Установка имени пользователя и электронной почты в Git

Git использует имя пользователя, чтобы связать коммиты с личностью. Имя пользователя Git не совпадает с вашим именем пользователя GitHub.

Вы можете изменить имя, связанное с вашими коммитами Git, с помощью команды git config. Изменение имени, связанного с вашими коммитами Git, с помощью git config повлияет только на будущие коммиты и не изменит имя, используемое для прошлых коммитов.

Вы успешно настроили Git и сможете разветвлять, создавать и клонировать ветки. В этой лаборатории кода мы будем широко использовать Git.

3. Репозиторий GCS форка CFT

Форк репозитория CFT

Вы настраиваете Git на своем локальном компьютере или в Cloud Shell на предыдущем этапе. Теперь вам нужно создать форк репозитория Google Cloud Storage CFT, чтобы начать вносить свой вклад.

Форк — это копия репозитория. Разветвление репозитория позволяет вам свободно экспериментировать с изменениями, не затрагивая исходный проект.

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

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

Форкните репозиторий.
Исправьте.
Отправьте запрос на включение владельцу проекта.

Шаги для форка репо CFT:

Откройте веб-браузер и перейдите в репозиторий terraform-google-modules/terraform-google-cloud-storage . Мы будем использовать этот репозиторий для всей Codelab.
В правом верхнем углу страницы нажмите «Развилка» .

Вам будет предложен вариант, где вы хотите разместить форк, выберите свой профиль, и репо будет форкано.

Клонируйте свою вилку локально

Созданная вами вилка является копией репозитория модулей GCS. Теперь вы клонируете этот репозиторий в свою локальную среду, чтобы добавить новую функцию.

Шаги по клонированию вашей вилки:

Откройте веб-браузер и перейдите к своей вилке terraform-google-modules/terraform-google-cloud-storage .
В правом верхнем углу вы найдете кнопку «Код», нажмите на нее.

После того, как вы нажали кнопку «Код», нажмите на значок «Копировать», чтобы скопировать URL-адрес форка. Вы будете использовать этот URL-адрес для клонирования своей вилки в локальную среду.

Перейдите к терминалу в вашем VSCode или на вашем компьютере и клонируйте вилку.

$ git clone <url>
# This command will clone your fork locally.
# Paste the copied URL from the previous step.

Теперь, когда вы клонировали свою вилку локально, вам следует зайти в свой репозиторий, создать новую ветку на основе вилки и внести изменения в код во временную ветку.

По соглашению вы можете назвать свою ветку следующим образом:

Для запросов на функции: feature/feature-name
Для внутренних обновлений: internal/change-name
Для исправления ошибок: bugfix/issue-name

Поскольку вы добавляете новую функцию, вы можете вызвать временную ветку feature/silly_label

$ cd terraform-google-cloud-storage
# This command takes you into the cloned directory on your local machine.

$ git branch
# This command tells your current branch
# When you run this for the first time after you have cloned, your 
# output should say "master", that is your fork.

$ git checkout -b feature/silly_label
# This command creates a new branch on your fork and switches your 
# branch to the newly created branch.

$ git branch
# This command will confirm your current branch to be "feature/silly_label"

Теперь все готово для начала работы с Cloud Foundation Toolkit!

4. Создайте тестовую среду

Стандартный процесс разработки CFT основан на использовании изолированного тестового проекта для тестирования. Этот шаг поможет вам создать тестовый проект (на основе стандартной конфигурации) через сервисную учетную запись.

0. Установите Docker Engine.

Если вы используете свою машину в целях разработки, вам необходимо установить Docker Engine .

1. Установите Google Cloud SDK.

Вам не нужно устанавливать Google Cloud SDK, если вы используете GCP Cloud Shell .

Перейдите в Google Cloud SDK и загрузите интерактивный установщик для вашей платформы.

2. Установите конфигурацию

Чтобы создать тестовую среду, вам понадобится облачная организация Google, тестовая папка и платежный аккаунт. Эти значения необходимо установить через переменные среды:

export TF_VAR_org_id="your_org_id"
export TF_VAR_folder_id="your_folder_id"
export TF_VAR_billing_account="your_billing_account_id"

3. Настройте свою учетную запись службы.

Прежде чем создавать тестовую среду, вам необходимо загрузить ключ служебной учетной записи в вашу тестовую среду. Для этого сервисного аккаунта потребуются роли «Создатель проекта», «Пользователь платежного аккаунта» и «Просмотр организации» . Эти шаги помогут вам создать новую учетную запись службы, но вы также можете повторно использовать существующую учетную запись.

3.1 Создайте или выберите начальный проект GCP

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

gcloud config set core/project YOUR_PROJECT_ID

3.2 Включите Google Cloud API

Включите следующие API Google Cloud в своем исходном проекте:

gcloud services enable cloudresourcemanager.googleapis.com
gcloud services enable iam.googleapis.com
gcloud services enable cloudbilling.googleapis.com

3.3 Создать учетную запись службы

Создайте новую учетную запись службы для управления тестовой средой:

# Creating a service account for CFT.
gcloud iam service-accounts create cft-onboarding \
  --description="CFT Onboarding Terraform Service Account" \
  --display-name="CFT Onboarding"

# Assign SERVICE_ACCOUNT environment variable for later steps
export SERVICE_ACCOUNT=cft-onboarding@$(gcloud config get-value core/project).iam.gserviceaccount.com

Убедитесь, что ваша учетная запись службы создана:

gcloud iam service-accounts list --filter="EMAIL=${SERVICE_ACCOUNT}"

3.4 Предоставьте сервисному аккаунту роли «Создатель проекта», «Пользователь платежного аккаунта» и «Просмотр организации»:

gcloud resource-manager folders add-iam-policy-binding ${TF_VAR_folder_id} \
  --member="serviceAccount:${SERVICE_ACCOUNT}" \
  --role="roles/resourcemanager.projectCreator"
gcloud organizations add-iam-policy-binding ${TF_VAR_org_id} \
  --member="serviceAccount:${SERVICE_ACCOUNT}" \
  --role="roles/billing.user"
gcloud beta billing accounts add-iam-policy-binding ${TF_VAR_billing_account} \
  --member="serviceAccount:${SERVICE_ACCOUNT}" \
  --role="roles/billing.user"
gcloud organizations add-iam-policy-binding ${TF_VAR_org_id} \
  --member="serviceAccount:${SERVICE_ACCOUNT}" \
  --role="roles/resourcemanager.organizationViewer"

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

4. Подготовьте учетные данные Terraform.

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

4.1 Ключ учетной записи службы

Создайте и загрузите ключ сервисной учетной записи для Terraform.

gcloud iam service-accounts keys create cft.json --iam-account=${SERVICE_ACCOUNT}

4.2 Настройка учетных данных Terraform

Предоставьте ключ в Terraform, используя переменную среды SERVICE_ACCOUNT_JSON , установив в качестве значения содержимое ключа вашей сервисной учетной записи.

export SERVICE_ACCOUNT_JSON=$(< cft.json)

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

rm -rf cft.json

5. Создайте тестовый проект для развертываний Terraform.

Теперь, когда все подготовлено, вы можете создать тестовый проект с помощью одной команды. Запустите эту команду из корня каталога terraform-google-cloud-storage:

make docker_test_prepare

Вы увидите приведенный ниже вывод, когда запустите make docker_test_prepare , в конце вы получите тестовый project_id, который был создан, где вы будете развертывать и тестировать свой модуль облачного хранилища с вашей новой функцией. Если у вас возникли проблемы с привязкой платежного аккаунта, обратитесь к инструкциям по устранению неполадок .

macbookpro3:terraform-google-cloud-storage user$ make docker_test_prepare
docker run --rm -it \
                -e SERVICE_ACCOUNT_JSON \
                -e TF_VAR_org_id \
                -e TF_VAR_folder_id \
                -e TF_VAR_billing_account \
                -v /Users/cft/terraform-google-cloud-storage:/workspace \
                gcr.io/cloud-foundation-cicd/cft/developer-tools:0.8.0 \
                /usr/local/bin/execute_with_credentials.sh prepare_environment
Activated service account credentials for: [cft-onboarding@<project_id>.iam.gserviceaccount.com]
Activated service account credentials for: [cft-onboarding@<project_id>.iam.gserviceaccount.com]
Initializing modules...

Initializing the backend...

Initializing provider plugins...

The following providers do not have any version constraints in configuration,
so the latest version was installed.

To prevent automatic upgrades to new major versions that may contain breaking
changes, it is recommended to add version = "..." constraints to the
corresponding provider blocks in configuration, with the constraint strings
suggested below.

* provider.google-beta: version = "~> 3.9"
* provider.null: version = "~> 2.1"
* provider.random: version = "~> 2.2"

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.
module.project.module.project-factory.null_resource.preconditions: Refreshing state... [id=8723188031607443970]
module.project.module.project-factory.null_resource.shared_vpc_subnet_invalid_name[0]: Refreshing state... [id=5109975723938185892]
module.project.module.gsuite_group.data.google_organization.org[0]: Refreshing state...
module.project.module.project-factory.random_id.random_project_id_suffix: Refreshing state... [id=rnk]
module.project.module.project-factory.google_project.main: Refreshing state... [id=<project-id>]
module.project.module.project-factory.google_project_service.project_services[0]: Refreshing state... [id=<project-id>/storage-api.googleapis.com]
module.project.module.project-factory.google_project_service.project_services[1]: Refreshing state... [id=<project-id>/cloudresourcemanager.googleapis.com]
module.project.module.project-factory.google_project_service.project_services[2]: Refreshing state... [id=<project-id>/compute.googleapis.com]
module.project.module.project-factory.data.null_data_source.default_service_account: Refreshing state...
module.project.module.project-factory.google_service_account.default_service_account: Refreshing state... [id=projects/ci-cloud-storage-ae79/serviceAccounts/project-service-account@<project-id>.iam.gserv
iceaccount.com]
module.project.module.project-factory.google_project_service.project_services[3]: Refreshing state... [id=<project-id>/serviceusage.googleapis.com]
module.project.module.project-factory.null_resource.delete_default_compute_service_account[0]: Refreshing state... [id=3576396874950891283]
google_service_account.int_test: Refreshing state... [id=projects/<project-id>/serviceAccounts/cft-onboarding@<project-id>.iam.gserviceaccount.com]
google_service_account_key.int_test: Refreshing state... [id=projects/<project-id>/serviceAccounts/cft-onboarding@<project-id>.iam.gserviceaccount.com/keys/351009a1e011e88049ab2097994d1c627a61
6961]
google_project_iam_member.int_test[1]: Refreshing state... [id=<project-id>/roles/iam.serviceAccountUser/serviceaccount:cft-onboarding@<project-id>.iam.gserviceaccount.com]
google_project_iam_member.int_test[0]: Refreshing state... [id=<project-id>/roles/storage.admin/serviceaccount:cft-onboarding@<project-id>.iam.gserviceaccount.com]

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

Outputs:

project_id = <test-project-id>
sa_key = <sensitive>
Found test/setup/make_source.sh. Using it for additional explicit environment configuration.

Теперь вы создали тестовый проект, на который ссылается project_id, как вы можете видеть в выводе консоли. Ваша среда разработки и тестирования настроена.

5. Добавьте новую функцию в модуль ЦФТ.

Теперь ваша среда разработки и тестирования настроена, давайте начнем добавлять функцию «silly_label» в модуль google-cloud-storage CFT.

Убедитесь, что вы находитесь в terraform-google-cloud-storage, и откройте файл main.tf, как вы видите ниже в структуре папок.

Поскольку «silly_label» — это метка, вы добавите эту функцию в строке 27 в переменную «labels» в файле main.tf, как показано ниже:

terraform-google-cloud-storage/main.tf

resource "google_storage_bucket" "buckets" {
 <...>
 storage_class = var.storage_class
 // CODELAB:Add silly label in labels variable
 labels        = merge(var.labels, { name = replace("${local.prefix}${lower(each.value)}", ".", "-") }, { "silly" = var.silly_label })
 force_destroy = lookup(
 <...>
}

Теперь вы добавите переменную silly_label в файлvariable.tf, который вы видите в приведенной выше структуре папок.

Скопируйте приведенный ниже код и добавьте его в строку 31 в файлеvariable.tf и убедитесь, что у вас есть новый символ строки выше и ниже добавляемого блока переменных.

terraform-google-cloud-storage/variables.tf

variable "names" {
 description = "Bucket name suffixes."
 type        = list(string)
}

// CODELAB: Add "silly_label" variable to variables.tf between "names" and "location"
variable "silly_label" {
 description = "Sample label for bucket."
 type        = string
}

variable "location" {
 description = "Bucket location."
 default     = "EU"
}

6. Добавьте новую функцию в пример сегмента хранилища.

Вы добавили свою функцию в файл main.tf модуля и теперь протестируете добавленную функцию на примере.

«silly_label» необходимо будет добавить в example/multiple-buckets/main.tf.

Этот пример будет использоваться на следующем этапе для выполнения интеграционных тестов.

Скопируйте и вставьте приведенную ниже строку переменной silly_label в строку 27 файла main.tf по адресу terraform-google-cloud-storage/examples/multiple-buckets/, как показано в структуре папок:

terraform-google-cloud-storage/examples/multiple-buckets/main.tf

module "cloud_storage" {
 <...>
 // CODELAB: Add "silly_label" as an example to main.tf.
 silly_label        = "awesome"

 <..>
}

7. Обновите тест чертежа, чтобы проверить функцию.

Вы добавили свою функцию в файл main.tf модуля, а затем добавили ее в пример Multiple_buckets. Теперь вам нужно протестировать свою функцию с помощью интеграционного теста, написанного на Golang.

Вы добавите новые тесты в файл Multiple_buckets_test.go, который находится в структуре папок ниже:

Вы добавили «silly_label» во все сегменты, создаваемые с помощью модуля Multiple_buckets, и теперь вам нужно написать тесты для тестирования новой функции.

В приведенном ниже коде вы получаете метку каждого сегмента с помощью команды gcloud Alpha Storage, а затем проверяете возвращаемый вывод команды.

test/integration/multiple_buckets/multiple_buckets_test.go

func TestMultipleBuckets(t *testing.T) {
 <..>
op := gcloud.Run(t, fmt.Sprintf("alpha storage ls --buckets gs://%s", bucketName), gcloudArgs).Array()[0]

// verify silly label on each bucket
assert.Equal("awesome", op.Get("metadata.labels.silly").String(), "should have silly label set to awesome")

// verify lifecycle rules
...
}

8. Выполнить интеграционные тесты в ЦФТ.

Интеграционное тестирование

Интеграционные тесты используются для проверки поведения корневого модуля, подмодулей и примеров. Дополнения, изменения и исправления должны сопровождаться тестами.

Интеграционные тесты пишутся с использованием среды тестирования Blueprint и запускаются с помощью CFT CLI . Для удобства эти инструменты упакованы в образ Docker.

Общая стратегия этих тестов — проверить поведение модулей-примеров , гарантируя тем самым, что корневой модуль, подмодули и модули-примеры функционально корректны.

При интерактивном выполнении каждый шаг выполняется с помощью нескольких команд.

Запустите make docker_run , чтобы запустить тестирование контейнера Docker в интерактивном режиме.

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

Когда вы запускаете make docker_run , вы создаете рабочую область в своем Docker-контейнере и активируете учетные данные для своей учетной записи службы. Рабочая область будет использоваться на следующих шагах для запуска тестов.

Вы увидите следующий вывод в своем терминале:

Activated service account credentials for: [cft@<PROJECT_ID>.iam.gserviceaccount.com]

Запустите cft test list чтобы просмотреть все тесты чертежей в вашем рабочем пространстве.

Вы увидите следующий вывод в своем терминале:

[root@CONTAINER_ID workspace]# cft test list
 NAME                           | CONFIG                    | LOCATION                                                   
--------------------------------+---------------------------+------------------------------------------------------------
 TestAll/examples/simple_bucket | examples/simple_bucket    | test/integration/discover_test.go                          
 TestMultipleBuckets            | examples/multiple_buckets | test/integration/multiple_buckets/multiple_buckets_test.go

Запустите cft test run <EXAMPLE_NAME> --stage init чтобы инициализировать пример. В этом случае для инициализации запуска теста TestMultipleBuckets cft test run TestMultipleBuckets --stage init . Вы также можете использовать флаг --verbose для получения дополнительной информации при запуске тестов.

Этот этап инициализации инициализирует пример Terraform.

Вы увидите приведенный ниже вывод в своем терминале.

[root@<CONTAINER_ID> workspace]# cft test run TestMultipleBuckets --stage init --verbose
INFO[02-09|08:24:31] using test-dir: test/integration 
...
TestMultipleBuckets 2022-02-09T08:24:35Z command.go:179: Terraform has been successfully initialized!
...
TestMultipleBuckets 2022-02-09T08:24:35Z command.go:100: Running command terraform with args [validate]
TestMultipleBuckets 2022-02-09T08:24:36Z command.go:179: Success! The configuration is valid.
...
--- PASS: TestMultipleBuckets (4.05s)

Запустите cft test run <EXAMPLE_NAME> --stage apply , чтобы применить пример модуля.

На этом этапе пример, инициализированный на предыдущем этапе, применяется к проекту GCP, созданному ранее в Codelab.

Вы увидите приведенный ниже вывод в своем терминале.

[root@<CONTAINER_ID> workspace]# cft test run TestMultipleBuckets --stage apply --verbose
INFO[02-09|08:28:11] using test-dir: test/integration
...
TestMultipleBuckets 2022-02-09T08:28:19Z command.go:179: Apply complete! Resources: 6 added, 0 changed, 0 destroyed.
TestMultipleBuckets 2022-02-09T08:28:19Z command.go:179: 
TestMultipleBuckets 2022-02-09T08:28:19Z command.go:179: Outputs:
TestMultipleBuckets 2022-02-09T08:28:19Z command.go:179: 
TestMultipleBuckets 2022-02-09T08:28:19Z command.go:179: names = {
TestMultipleBuckets 2022-02-09T08:28:19Z command.go:179:   "one" = "multiple-buckets-erp1-eu-one"
...
--- PASS: TestMultipleBuckets (6.51s)
PASS
ok      github.com/terraform-google-modules/terraform-google-cloud-storage/test/integration/multiple_buckets    6.548s

Запустите cft test run <EXAMPLE_NAME> --stage verify чтобы убедиться, что пример создал ожидаемую инфраструктуру.

На этом шаге будет запущена функция проверки в TestMultipleBuckets . Обычно проверка выполняется путем выполнения команды gcloud для получения выходных данных JSON для текущего состояния ресурса и подтверждения того, что текущее состояние соответствует заявленному в примере.

Если вы получите какие-либо ошибки, вы увидите, что ожидалось и что получила команда для теста.

Вы увидите приведенный ниже вывод в своем терминале.

cft test run TestMultipleBuckets --stage verify --verbose
INFO[02-09|08:30:19] using test-dir: test/integration
...
TestMultipleBuckets 2022-02-09T08:30:27Z command.go:100: Running command terraform with args [output -no-color -json names_list]
TestMultipleBuckets 2022-02-09T08:30:27Z command.go:179: ["multiple-buckets-erp1-eu-one","multiple-buckets-erp1-eu-two"]
TestMultipleBuckets 2022-02-09T08:30:27Z command.go:100: Running command gcloud with args [alpha storage ls --buckets gs://multiple-buckets-erp1-eu-one --project ci-cloud-storage-8ce9 --json]
TestMultipleBuckets 2022-02-09T08:30:28Z command.go:179: [
TestMultipleBuckets 2022-02-09T08:30:28Z command.go:179: {
TestMultipleBuckets 2022-02-09T08:30:28Z command.go:179:   "url": "gs://multiple-buckets-erp1-eu-one/",
...
TestMultipleBuckets 2022-02-09T08:30:33Z command.go:179: ]
2022/02/09 08:30:33 RUN_STAGE env var set to verify
2022/02/09 08:30:33 Skipping stage teardown
--- PASS: TestMultipleBuckets (12.32s)
PASS
ok      github.com/terraform-google-modules/terraform-google-cloud-storage/test/integration/multiple_buckets    12.359s

Запустите cft test run <EXAMPLE_NAME> --stage teardown чтобы удалить пример.

Этот шаг уничтожает инфраструктуру, созданную вами на предыдущих шагах. На этом этапе также будут уничтожены сегменты GCS, созданные в проекте, вместе с меткой, которую вы добавили в модуль GCS.

Вы можете просмотреть приведенный ниже вывод в своем терминале.

[root@<CONTAINER_ID> workspace]# cft test run TestMultipleBuckets --stage teardown --verbose
INFO[02-09|08:36:02] using test-dir: test/integration
...
TestMultipleBuckets 2022-02-09T08:36:06Z command.go:100: Running command terraform with args [destroy -auto-approve -input=false -lock=false]
TestMultipleBuckets 2022-02-09T08:36:07Z command.go:179: module.cloud_storage.random_id.bucket_suffix: Refreshing state... [id=mNA]
TestMultipleBuckets 2022-02-09T08:36:07Z command.go:179: random_string.prefix: Refreshing state... [id=erp1]
TestMultipleBuckets 2022-02-09T08:36:08Z command.go:179: module.cloud_storage.google_storage_bucket.buckets["two"]: Refreshing state... [id=multiple-buckets-erp1-eu-two]
...
TestMultipleBuckets 2022-02-09T08:36:10Z command.go:179: Destroy complete! Resources: 6 destroyed.
TestMultipleBuckets 2022-02-09T08:36:10Z command.go:179: 
--- PASS: TestMultipleBuckets (6.62s)
PASS
ok      github.com/terraform-google-modules/terraform-google-cloud-storage/test/integration/multiple_buckets    6.654s

Запустите exit , чтобы выйти из тестового контейнера.

9. Создание документации для входов и выходов

Таблицы входов и выходов в файлах README корневого модуля, подмодулей и примеров модулей автоматически генерируются на основе variables и outputs соответствующих модулей. Эти таблицы необходимо обновить, если интерфейсы модулей изменяются.

Бегать:

make generate_docs
# This will generate new Inputs and Outputs tables

10. Выполните тесты на ворс в CFT.

Линтер — это инструмент, который анализирует исходный код для выявления ошибок программирования, ошибок, стилистических ошибок и подозрительных конструкций.

Многие файлы в репозитории можно линковать или отформатировать для поддержания стандартов качества. Чтобы гарантировать качество в CFT, вы будете использовать тест на ворс.

Бегать:

make docker_test_lint
# This will run all lint tests on your repo

11. Размещение PR на Github

Теперь, когда вы изменили свой код локально и протестировали его с помощью интеграционных тестов, вам нужно опубликовать этот код в главном репозитории.

Чтобы сделать ваш код доступным в главном репозитории, вам необходимо зафиксировать изменения кода в своей ветке и отправить их в главный репозиторий. Чтобы ваш код был добавлен в основной репозиторий, который вы разветвили в начале Codelab, вы создадите запрос на включение (PR) в главном репозитории после фиксации кода в вашем репозитории.

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

На основании изменений вашего кода рецензенты кода будут комментировать ваш код и просить внести изменения, если что-то необходимо изменить на основе лучших практик и документации. Администратор проверит изменения вашего кода, убедится, что ваш код соответствует репозиторию, и может снова попросить вас внести некоторые изменения перед объединением вашего кода с основным репозиторием.

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

Первый шаг — добавить измененные файлы в локальное репо.

$ git add main.tf
$ git add README.md
$ git add variables.tf
$ git add examples/multiple-buckets/main.tf
$ git add test/integration/multiple_buckets/multiple_buckets_test.go
# The ‘git add' command adds the file in the local repository and 
# stages the file for commit. To unstage a file, use git reset HEAD YOUR-FILE

Ваши файлы теперь подготовлены, затем вы зафиксируете изменения.

$ git commit -m "First CFT commit"
# This will commit the staged changes and prepares them to be pushed 
# to a remote repository. To remove this commit and modify the file, 
# use 'git reset --soft HEAD~1' and commit and add the file again.

Отправьте зафиксированные изменения в локальном репозитории на GitHub для создания запроса на включение (PR).

$ git push -u origin feature/silly_label
# Pushes the changes in your local repository up to the remote
# repository you specified as the origin

Ваши изменения кода теперь готовы к запросу на включение!

Выполните следующие шаги, чтобы создать PR для репозитория terraform-google-modules/terraform-google-cloud-storage :

В веб-браузере перейдите на главную страницу репозитория .
Через баннер вы увидите предложение открыть PR с вашего форка. Нажмите «Сравнить и запросить извлечение».

Введите заголовок и описание запроса на включение, чтобы описать изменения кода. Будьте максимально конкретны, но при этом кратки.

Чтобы создать запрос на включение, готовый к рассмотрению, нажмите «Создать запрос на включение».
Вы увидите запущенные триггеры Cloud Build, которые срабатывают из-за PR.
Если у вас возникнут какие-либо проблемы, обратитесь к официальной документации GitHub по открытию запросов на извлечение из форков .

Вы успешно внесли свое первое изменение кода в разветвленную ветку и подняли свой первый PR CFT в основной ветке!

12. Поздравления

Поздравляем, вы успешно добавили функцию в модуль CFT и отправили заявку на рассмотрение!

Вы добавили функцию в модуль CFT, протестировали ее локально на примере и выполнили тесты перед отправкой кода на GitHub. Наконец, вы подали заявку на рассмотрение и окончательное слияние с ЦФТ.

Теперь вы знаете важные шаги для начала работы с Cloud Foundation Toolkit.