fix(CLOUDDEV-414): fixed makefile and readme instructions #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DamirZinatullin
force-pushed
the
fix/CLOUDDEV-414-fix-makefile-and-readme
branch
4 times, most recently
from
126ef59 to
64c4a38
Compare
alex2304
reviewed
Jan 16, 2024
README.md
Outdated
|
|
||
| ### Writing modules files | ||
|
|
||
| Create module files using the examples provided in the folder ./examples |
There was a problem hiding this comment.
nit: in the ./examples folder
README.md
Outdated
| ``` | ||
| ### Project initializing | ||
|
|
||
| #### Prepare module configure file |
README.md
Outdated
| It is necessary to add provider settings according to the instructions https://developer.hashicorp.com/terraform/language/providers/requirements: | ||
| Each Terraform module must declare which providers it requires, so that Terraform can install and use them. | ||
|
|
||
| To use the provider, prepare configuration file `provider.tf` in module directory |
README.md
Outdated
| } | ||
| ``` | ||
| #### Initialize working directory | ||
| Run terraform init in module directory. |
README.md
Outdated
| Before initializing the project you should to set VAULT_ADDR and VAULT_TOKEN envs: | ||
| ```bash | ||
| export VAULT_ADDR=<you can ask address from Cloud team (matermost tag: @devcloud)> | ||
| export VAULT_TOKEN=<you can generate this token in ${VAULT_ADDR} page> |
README.md
Outdated
| export VAULT_TOKEN=<you can generate this token in ${VAULT_ADDR} page> | ||
| ``` | ||
| #### Initialize | ||
| Initialize the project this command: |
README.md
Outdated
| ```sh | ||
| $ make init | ||
| ``` | ||
| This command creates ./bin and install jq, godotenv, golangci-lint utils. Then the command downloads env file from vault to ./edgecenter/test/.env and |
There was a problem hiding this comment.
не обязательно писать, что делает команда, т.к. это может поменяться в коде
в данном случае баш код команды self-descriptive
README.md
Outdated
|
|
||
| ### Using built Terraform provider | ||
|
|
||
| If you want use built provider from previous step, or use dubug mode, you should add dev_overrides opts to |
There was a problem hiding this comment.
To use the built provider from the previous step, you should add the dev_overrides option to the ~/.terraformrc file:
|
Заметил еще пару вещей, отписал в ПР Так же, в секции В принципе, я бы проверил всю секцию Debug, потому что если там есть не работающие вещи, их стоит либо поправить, либо лучше тогда вообще убрать |
|
Аппрувнул ПР, чтобы не затягивать код-ревью Не забудь перед мержем:
|
alex2304
approved these changes
Jan 16, 2024
README.md
Outdated
| ``` | ||
| For testing not cloud (storage, cdn, dns) data sources and resources: | ||
| ```bash | ||
| make test_not_cloud: |
Makefile
Outdated
| @@ -24,9 +24,33 @@ TAG = $(shell git describe --tags) | |||
| VERSION = $(shell git describe --tags $(LAST_TAG_COMMIT) | sed "s/^$(TAG_PREFIX)//") | |||
| PLUGIN_PATH = ~/.terraform.d/plugins/local.edgecenter.ru/repo/edgecenter/$(VERSION)/$(OS)_$(ARCH) | |||
|
|
|||
|
|
|||
| create_bin: | |||
| mkdir -p bin | |||
Makefile
Outdated
|
|
||
| install_jq: | ||
| if test "$(OS)" = "linux"; then \ | ||
| curl -L -o $(BIN_DIR)/jq https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64; \ |
There was a problem hiding this comment.
В идеале использовать $ARCH: у меня например мак на M1
.gitignore
Outdated
| @@ -12,6 +12,7 @@ terraform.tfstate | |||
| ### bin | |||
| bin/ | |||
| .local.env | |||
| edgecenter/test/.env | |||
There was a problem hiding this comment.
**/*.env? Чтобы все .env файлы сразу вместо этих двух
и не в секции ### bin
DamirZinatullin
force-pushed
the
fix/CLOUDDEV-414-fix-makefile-and-readme
branch
from
fa90df5 to
357efe5
Compare
DamirZinatullin
force-pushed
the
fix/CLOUDDEV-414-fix-makefile-and-readme
branch
from
357efe5 to
4abb1ee
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.