Mention OpenTofu; clean up repo.

README.md

@@ -1,16 +1,12 @@
 # Terraform Provider for Codefresh
 
-This is the official Terraform Provider for Codefresh.
+The official Terraform and OpenTofu Provider for [Codefresh](https://codefresh.io/).
 
 Terraform Registry: [registry.terraform.io/providers/codefresh-io/codefresh](https://registry.terraform.io/providers/codefresh-io/codefresh/latest)
 
 ## Requirements
 
-- [Terraform](https://www.terraform.io/downloads.html) `1.x.x` 
-
-## Download the Provider
-
-Download and extract terraform-provider-codefresh from [releases](https://github.com/codefresh-io/terraform-provider-codefresh/releases)
+- [Terraform](https://www.terraform.io/downloads.html) `1.x.x`  or [OpenTofu](https://github.com/opentofu/opentofu/releases/latest) `1.x.x`.
 
 ## Using the Provider
 
@@ -21,12 +17,14 @@ terraform {
   required_providers {
     codefresh = {
       version = "x.y.z" # Optional but recommended; replace with latest semantic version
-      source = "codefresh-io/codefresh"
+       source = "registry.terraform.io/codefresh-io/codefresh" # registry.terraform.io/ is optional for Terraform users, but required for OpenTofu users
     }
   }
 }
 ```
 
+You can also download and extract the provider binary (`terraform-provider-codefresh`) from [releases](https://github.com/codefresh-io/terraform-provider-codefresh/releases).
+
 ## Building the Provider Locally
 
 ```sh
@@ -39,37 +37,34 @@ The documentation is generated using [tfplugindocs](https://github.com/hashicorp
 
 See: [CONTRIBUTING.md](./CONTRIBUTING.md#documentation)
 
-## To configure Codefresh provider:
+## Provider Configuration:
 
-```hcl
-provider "codefresh" {
-  api_url = "<MY API URL>" # Default value - https://g.codefresh.io/api
-  token = "<MY API TOKEN>" # If token isn't set the provider expects the $CODEFRESH_API_KEY env variable
-}
-```
+See the [Provider Documentation](https://registry.terraform.io/providers/codefresh-io/codefresh/latest/docs#schema).
 
-Get an API key from [Codefresh](https://g.codefresh.io/user/settings) and set the following scopes:
+The provider requires a Codefresh API in order to authenticate to the Codefresh API. Generate the API key [here](https://g.codefresh.io/user/settings) and set the scopes [according to the resources you wish to create](https://codefresh.io/docs/docs/integrations/codefresh-api/#access-scopes). Note that some resource require platform admin permissions and hence can only be created for on-prem installations and not our SaaS offering.
 
-- Environments-V2
-- Pipeline
-- Project
-- Repos
-- Step-Type
-- Step-Types
-- View
+The key can be set as an environment variable:
 
 ```bash
 export CODEFRESH_API_KEY='xyz'
 ```
 
 ## Testing the Provider
 
-**NOTE:** Acceptance tests create real resources, including admin resources (accounts, users) so make sure that `CODEFRESH_API_KEY` is set to an account that you are ok with being modified.
+**NOTE:** Acceptance tests create real resources, including admin resources (accounts, users) so make sure that `CODEFRESH_API_KEY` is set to a Codefresh installation and an account that you are ok with being modified.
 
 ```bash
 make testacc
 ```
 
+## OpenTofu Support
+
+This provider supports [OpenTofu](https://opentofu.org/).
+
+[Equivalence Testing](https://github.com/opentofu/equivalence-testing) is performed on the `examples/` directory in order to ensure that the provider behaves identically when used by either  `terraform` and `tofu` binaries.
+
+The [OpenTofu Registry](https://registry.opentofu.org/) seems to be unpublished at time of writing. As of now, the provider is only published to the [Terraform Registry](https://registry.terraform.io/providers/codefresh-io/codefresh/latest).
+
 ## Contributors
 
 <a href="https://github.com/codefresh-io/terraform-provider-codefresh/graphs/contributors">

examples/abac_rules/main.tf

@@ -12,10 +12,10 @@ resource "codefresh_abac_rules" "app_rule" {
   actions     = ["REFRESH", "SYNC", "TERMINATE_SYNC", "VIEW_POD_LOGS", "APP_ROLLBACK"]
 
   attribute {
-    name = "LABEL"
-    key = "KEY"
+    name  = "LABEL"
+    key   = "KEY"
     value = "VALUE"
   }
 
-  tags        = ["dev", "untagged"]
+  tags = ["dev", "untagged"]
 }

examples/abac_rules/provider.tf

@@ -1,5 +1,5 @@
 provider "codefresh" {
-  api_url =  var.api_url
-  api_url_v2 =  var.api_url_v2
-  token = var.token # If token isn't set the provider expects the $CODEFRESH_API_KEY env variable
+  api_url    = var.api_url
+  api_url_v2 = var.api_url_v2
+  token      = var.token # If token isn't set the provider expects the $CODEFRESH_API_KEY env variable
 }

examples/abac_rules/terraform.tfvars

@@ -1,3 +1,3 @@
-api_url = "https://my-codefresh.example.com/api"
+api_url    = "https://my-codefresh.example.com/api"
 api_url_v2 = "https://my-codefresh.example.com/2.0/api/graphql"
-token = ""
+token      = ""

examples/abac_rules/vars.tf

@@ -1,12 +1,12 @@
-variable api_url {
+variable "api_url" {
   type = string
 }
 
-variable api_url_v2 {
+variable "api_url_v2" {
   type = string
 }
 
-variable token {
-  type = string
+variable "token" {
+  type    = string
   default = ""
 }

examples/abac_rules/versions.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     codefresh = {
-      source = "codefresh-io/codefresh"
+      source  = "registry.terraform.io/codefresh-io/codefresh"
       version = "~> 0.1"
     }
   }

examples/account_tokens/main.tf

@@ -1,24 +1,24 @@
-variable api_url {
+variable "api_url" {
   type = string
 }
 
 # 
-variable token {
-  type = string
+variable "token" {
+  type    = string
   default = ""
 }
 
 ## Set of account names
-variable accounts {
+variable "accounts" {
   type = set(string)
 }
 
 module "account_tokens" {
-    source = "../../tf_modules/account_tokens"
-    api_url = var.api_url
-    accounts = var.accounts
+  source   = "../.modules/account_tokens"
+  api_url  = var.api_url
+  accounts = var.accounts
 }
 
 output "account_tokens" {
-    value = module.account_tokens.tokens
+  value = module.account_tokens.tokens
 }

examples/account_tokens/terraform.tfvars

@@ -1,5 +1,5 @@
 api_url = "https://my-codefresh-example.com/api"
 
 accounts = [
-"acc1", "acc2"
+  "acc1", "acc2"
 ]

examples/account_tokens/versions.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     codefresh = {
-      source = "codefresh-io/codefresh"
+      source  = "registry.terraform.io/codefresh-io/codefresh"
       version = "~> 0.1"
     }
   }

examples/account_user_associations/main.tf

@@ -1,8 +1,8 @@
 resource "codefresh_account_user_association" "user" {
-    email = "[email protected]"
+  email = "[email protected]"
 }
 
 resource "codefresh_account_user_association" "admin" {
-    email = "[email protected]"
-    admin = true
+  email = "[email protected]"
+  admin = true
 }

examples/account_user_associations/versions.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     codefresh = {
-      source = "codefresh-io/codefresh"
+      source = "registry.terraform.io/codefresh-io/codefresh"
     }
   }
 }

examples/accounts_users/main.tf

@@ -1,9 +1,9 @@
 module "codefresh_access_control" {
-  source = "../../tf_modules/accounts_users"
-  api_url = var.api_url
+  source       = "../.modules/accounts_users"
+  api_url      = var.api_url
   default_idps = var.default_idps
-  accounts = var.accounts
-  users = var.users
+  accounts     = var.accounts
+  users        = var.users
 
   default_acccount_limits = var.default_acccount_limits
 }

examples/accounts_users/terraform.tfvars

@@ -1,56 +1,56 @@
 api_url = "https://my-codefresh.example.com/api"
-token = "cfAdmin-token"
+token   = "cfAdmin-token"
 
 default_idps = {
-    local = {
-       display_name = "local"
-       sso = false
-    }
-    azure_sso = { 
-        display_name = "azure-sso-1"
-        sso = true
-    }
+  local = {
+    display_name = "local"
+    sso          = false
+  }
+  azure_sso = {
+    display_name = "azure-sso-1"
+    sso          = true
+  }
 }
 
 accounts = {
-    acc1 = {}
-    acc2 = {
-        limits = {
-            collaborators = 50
-            parallel_builds = 5
-        }
+  acc1 = {}
+  acc2 = {
+    limits = {
+      collaborators   = 50
+      parallel_builds = 5
     }
+  }
 }
 
 users = {
-    user1 = {
-        email = "[email protected]"
-        personal = {
-            first_name = "John"
-            last_name = "Smith"
-        }
-        accounts = ["acc1", "acc2"]
-        admin_of_accounts = ["acc1"]
-        global_admin = true
+  user1 = {
+    email = "[email protected]"
+    personal = {
+      first_name = "John"
+      last_name  = "Smith"
     }
-    user2 = {
-        email = "live.com#[email protected]"
-        personal = {
-            first_name = "Q"
-            last_name = "D"
-        }
-        accounts = ["acc2"]
-        admin_of_accounts = []
-        global_admin = false
+    accounts          = ["acc1", "acc2"]
+    admin_of_accounts = ["acc1"]
+    global_admin      = true
+  }
+  user2 = {
+    email = "live.com#[email protected]"
+    personal = {
+      first_name = "Q"
+      last_name  = "D"
     }
-    user3 = {
-        email = "[email protected]"
-        personal = {
-            first_name = "Sam"
-            last_name = "Johnson"
-        }
-        accounts = ["acc1", "acc2"]
-        admin_of_accounts = ["acc1", "acc2"]
-        global_admin = true
+    accounts          = ["acc2"]
+    admin_of_accounts = []
+    global_admin      = false
+  }
+  user3 = {
+    email = "[email protected]"
+    personal = {
+      first_name = "Sam"
+      last_name  = "Johnson"
     }
+    accounts          = ["acc1", "acc2"]
+    admin_of_accounts = ["acc1", "acc2"]
+    global_admin      = true
+  }
 }

examples/accounts_users/vars.tf

@@ -1,22 +1,22 @@
-variable api_url {}
+variable "api_url" {}
 
-variable default_acccount_limits {
-    type = map(any)
-    default = {
-        collaborators = 100
-        parallel_builds = 10
-    }
+variable "default_acccount_limits" {
+  type = map(any)
+  default = {
+    collaborators   = 100
+    parallel_builds = 10
+  }
 }
 
-variable default_idps {
+variable "default_idps" {
   type = map(any)
 }
 
-variable accounts {
+variable "accounts" {
   type = map(any)
 }
 
-variable users {
+variable "users" {
   //type = map(any)
 }
 

examples/accounts_users/versions.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     codefresh = {
-      source = "codefresh-io/codefresh"
+      source  = "registry.terraform.io/codefresh-io/codefresh"
       version = "~> 0.1"
     }
   }

examples/permissions/provider.tf

@@ -1,4 +1,4 @@
 provider "codefresh" {
-  api_url =  var.api_url 
-  token = var.token # If token isn't set the provider expects the $CODEFRESH_API_KEY env variable
+  api_url = var.api_url
+  token   = var.token # If token isn't set the provider expects the $CODEFRESH_API_KEY env variable
 }

examples/permissions/vars.tf

@@ -1,8 +1,8 @@
-variable api_url {
+variable "api_url" {
   type = string
 }
 
-variable token {
-  type = string
+variable "token" {
+  type    = string
   default = ""
 }