{"id":20661827,"url":"https://github.com/mirantis/terraform-provider-k0sctl","last_synced_at":"2025-04-19T15:47:49.989Z","repository":{"id":211261352,"uuid":"728581760","full_name":"Mirantis/terraform-provider-k0sctl","owner":"Mirantis","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-01T13:19:36.000Z","size":90,"stargazers_count":4,"open_issues_count":2,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-29T09:34:13.804Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mirantis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":null},"created_at":"2023-12-07T08:50:23.000Z","updated_at":"2024-07-10T12:07:48.000Z","dependencies_parsed_at":"2023-12-13T15:39:39.204Z","dependency_job_id":"6795f48e-ec33-4fb9-bbca-d11c438d0124","html_url":"https://github.com/Mirantis/terraform-provider-k0sctl","commit_stats":null,"previous_names":["mirantis/terraform-provider-k0sctl"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirantis%2Fterraform-provider-k0sctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirantis%2Fterraform-provider-k0sctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirantis%2Fterraform-provider-k0sctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mirantis%2Fterraform-provider-k0sctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mirantis","download_url":"https://codeload.github.com/Mirantis/terraform-provider-k0sctl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249730571,"owners_count":21317327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T19:11:47.801Z","updated_at":"2025-04-19T15:47:49.973Z","avatar_url":"https://github.com/Mirantis.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mirantis K0S Ctl provider\n\nA terraform provider which integrates the k0s project tooling to natively\nconvert a set of hosts to a kubernetes cluster using terraform resources.\n\nThis provider is developed internally, and comes with no warranty. Use it \nat your own risk.\n\n## Requirements\n\n- [Terraform](https://www.terraform.io/downloads.html) \u003e= 1.4\n- [Go](https://golang.org/doc/install) \u003e= 1.20\n- [GoReleaser](https://goreleaser.com/) : If you want to use it locally\n\n## Building The Provider\n\n1. Clone the repository\n2. Enter the repository directory\n3. Build the provider using the `make local` command (uses goreleaser)\n\n```shell\n $/\u003e make local\n```\n\n## Adding Dependencies\n\nThis provider uses [Go modules](https://github.com/golang/go/wiki/Modules).\nPlease see the Go documentation for the most up to date information about using\nGo modules.\n\nTo add a new dependency `github.com/author/dependency` to your Terraform provider:\n\n```shell\ngo get github.com/author/dependency\ngo mod tidy\n```\n\nThen commit the changes to `go.mod` and `go.sum`.\n\n## Using the provider\n\nThe provider, once installed properly can be used in any terraform root/chart.\n\n### Using the released provider\n\nGo to the terraform registry page and follow the instructions for declaring\nthe provider version in your chart/module\n\n@see https://registry.terraform.io/providers/Mirantis/k0sctl/latest\n\n### Using the local source code provider\n\nThe `make local` target will use goreleaser to build the provider, and\nthen provide instructions on how to configure `terraform` to use the\nprovider locally,\n\n@see https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers\n\n## Developing the Provider\n\n### Using the local provider\n\nYou can develop the provider locally, and test the development version by building\nthe plugin locally, and then configuring terraform to use the local version as a\n`dev_override` for the production version.\n\nTo build the local plugin:\n```\nmake local\n```\n\nIt is recommended that you use the `dev_override` by using a special TF config file\nand running terraform with an environment variable telling it to use the special file.\nThis avoids using the development version globally, preventing simple mistakes.\n\nFirst create a file like my_tf_config_file:\n\n```\nprovider_installation {\n# This disables the version and checksum verifications for this provider\n# and forces Terraform to look for the k0sctl provider plugin in the\n# given directory.\ndev_overrides {\n\t\"mirantis/k0sctl\" = \"path/to/this/repo/dist/terraform-provider-k0sctl_linux_amd64_v1\"\n}\n# For all other providers, install them directly from their origin provider\n# registries as normal. If you omit this, Terraform will _only_ use\n# the dev_overrides block, and so no other providers will be available.\ndirect {}\n}\n```\n\n@NOTE that you mus replace `linux` and `amd64` if you are on a Mac/Windows machine\n  or not on a 64bit intel/amd processor.  See `go env GOOS` and `go env GOARCH` for\n  the correct values.\n\nthen run terraform with a config file override pointing to the new file:\n```\n $/\u003e TF_CLI_CONFIG_FILE=my_tf_config_file terraform plan\n```\n(or use an environment variable export)\n\n@see: https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers\"\n\n### Contributing\n\nTo generate or update documentation, run `go generate`.\n\nIn order to run the testing mode unit test suite:\n\n```\nmake test\n```\n\nIn order to run the full suite of Acceptance tests, run `make testacc`.\n\n*Note:* Acceptance tests require that you have an environment set up for\n\t\ttesting that k0sctl can use.\n\n```shell\nmake testacc\n```\n\n\u003c!-- BEGIN_TF_DOCS --\u003e\n## Requirements\n\nNo requirements.\n\n## Providers\n\nNo providers.\n\n## Modules\n\nNo modules.\n\n## Resources\n\nNo resources.\n\n## Inputs\n\nNo inputs.\n\n## Outputs\n\nNo outputs.\n\u003c!-- END_TF_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirantis%2Fterraform-provider-k0sctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmirantis%2Fterraform-provider-k0sctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirantis%2Fterraform-provider-k0sctl/lists"}