Adding resources doc for TF registry (#30)

* Adding the proper env var for tests

* Adding the full documentation

* Fixing the formatting

* Fixing the required

* Adding the conflicts

* Adding the proper doc

Author: sam-dumont

.gitignore

@@ -15,4 +15,5 @@
 # vendor/
 .terraform
 *tfstate*
-crash.log
+crash.log
+coverage.out

GNUmakefile

@@ -1,4 +1,3 @@
-WEBSITE_REPO=github.com/hashicorp/terraform-website
 PKG_NAME=kubeflowpipelines
 GOFMT_FILES?=$$(find . -name '*.go' |grep -v vendor)
 
@@ -14,18 +13,4 @@ testacc:
 	TF_ACC=1 KUBEFLOWPIPELINES_HOST=http://localhost:8080 go test -v ./... -timeout 120m -covermode=count -coverprofile=coverage.out
 
 fmt:
-	gofmt -w $(GOFMT_FILES)
-
-website:
-ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
-	echo "$(WEBSITE_REPO) not found in your GOPATH (necessary for layouts and assets), get-ting..."
-	git clone https://$(WEBSITE_REPO) $(GOPATH)/src/$(WEBSITE_REPO)
-endif
-	@$(MAKE) -C $(GOPATH)/src/$(WEBSITE_REPO) website-provider PROVIDER_PATH=$(shell pwd) PROVIDER_NAME=$(PKG_NAME)
-
-website-test:
-ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
-	echo "$(WEBSITE_REPO) not found in your GOPATH (necessary for layouts and assets), get-ting..."
-	git clone https://$(WEBSITE_REPO) $(GOPATH)/src/$(WEBSITE_REPO)
-endif
-	@$(MAKE) -C $(GOPATH)/src/$(WEBSITE_REPO) website-provider-test PROVIDER_PATH=$(shell pwd) PROVIDER_NAME=$(PKG_NAME)
+	gofmt -w $(GOFMT_FILES)

README.md

@@ -10,4 +10,20 @@ Terraform provider for Kubeflow Pipelines API
 
 ## Usage
 
-[Documentation available on the Terraform Registry](https://registry.terraform.io/providers/datarootsio/kubeflowpipelines/latest/docs)
+[Documentation available on the Terraform Registry](https://registry.terraform.io/providers/datarootsio/kubeflowpipelines/latest/docs)
+
+Developed and validated against kubeflow 1.0.2
+
+## Contributing
+
+Contributions to this repository are very welcome! Found a bug or do you have a suggestion? Please open an issue. Do you know how to fix it? Pull requests are welcome as well! To get you started faster, a Makefile is provided.
+
+Make sure to install [Terraform](https://learn.hashicorp.com/terraform/getting-started/install.html), [Go](https://golang.org/doc/install) (for automated testing) and Make (optional, if you want to use the Makefile) on your computer. Install [tflint](https://github.com/terraform-linters/tflint) to be able to run the linting.
+
+* Format your code: `make fmt`
+* Run tests: `make test`
+* Run acceptance tests: `make testacc`. This creates resources on your Kubernetes cluster, use with caution. We use [k3s](https://k3s.io/) in the CICD pipelines, to start from a fresh environment each time.
+
+## License
+
+MIT license. Please see [LICENSE](LICENSE) for details.

docs/index.md

@@ -1,6 +1,9 @@
 # Kubeflow Pipelines Provider
 
 Terraform provider for [Kubeflow Pipelines API](https://www.kubeflow.org/docs/pipelines/pipelines-quickstart/).
+
+Developed and validated against kubeflow 1.0.2
+
 ## Example Usage
 
 ```hcl-terraform

docs/resources/experiment.md

@@ -0,0 +1,26 @@
+# kubeflowpipelines_experiment
+
+The `kubeflowpipelines_experiment` creates a kubeflow pipelines experiment.
+
+## Example Usage
+
+```hcl-terraform
+resource "kubeflowpipelines_experiment" "example" {
+  name        = "example-experiment"
+  description = "Some description"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+### Required arguments
+* `name` — (Required) Name of the experiment.
+### Optional arguments
+* `description` — (Optional) Description of the experiment.
+
+## Attributes Reference
+
+The following attribute is exported:
+
+* `created_at` — The date and time of creation, formatted with RFC3339.

docs/resources/job.md

@@ -0,0 +1,73 @@
+# kubeflowpipelines_job
+
+The `kubeflowpipelines_job` creates a kubeflow pipelines job
+
+## Example Usage
+
+```hcl-terraform
+resource "kubeflowpipelines_job" "example" {
+	name            = "example"
+	description     = "Description"
+	service_account = "pipeline-runner"
+	enabled         = true
+	max_concurrency = 2
+	no_catchup      = true
+	experiment_id = kubeflowpipelines_experiment.example.id
+	pipeline_spec {
+		pipeline_version_id = kubeflowpipelines_pipeline.example.version_id
+		parameters = {
+			"key" = "value"
+		}
+	}
+	trigger {
+		cron_schedule {
+            start_time = "2020-06-23T00:00:00Z"
+            end_time   = "2030-06-23T00:00:00Z"
+            cron       = "0 0/10 * * * ?"
+
+		}
+	}
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+### Required arguments
+* `name` — (Required).
+* `max_concurrency` — (Required). Maximum number of concurrent runs for this job. Value must be between `1` and `10` included.
+* `pipeline_spec` — (Required). The pipeline specifications of this job.
+* `trigger` — (Required). The trigger rules for this job. Contains either `cron_schedule` or `periodic_schedule` block.
+
+### Optional arguments
+* `description` — (Optional). A description for the run.
+* `enabled` — (Optional, defaults to `true`). Is the job enabled ?
+* `service_account` — (Optional). The service account to attach this job to.
+* `experiment_id` — (Optional). The experiment that will store this jon.
+* `no_catchup` — (Optional, defaults to `true`). Whether the job should catch up if behind schedule. If true, the job will only schedule the latest interval if behind schedule. If false, the job will catch up on each past interval.
+
+### Nested Blocks
+
+#### pipeline_spec
+
+* `pipeline_version_id` — (Required). The pipeline version ID associated to this run.
+* `parameters` — (Optional). A map of key values of parameters.
+
+#### cron_schedule
+
+* `start_time` — (Required). The start time in RFC3339 format.
+* `end_time` — (Required). The end time in RFC3339 format.
+* `cron` — (Required). A schedule represented with the cron format, with the [quartz format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/tutorial-lesson-06.html). Must include seconds.
+
+#### periodic_schedule
+
+* `start_time` — (Required). The start time in RFC3339 format.
+* `end_time` — (Required). The end time in RFC3339 format.
+* `interval_seconds` — (Required). The interval between each run, in seconds.
+
+## Attributes Reference
+
+The following attribute is exported:
+
+* `created_at` — The date and time of creation, formatted with RFC3339.

docs/resources/pipeline.md

@@ -0,0 +1,43 @@
+# kubeflowpipelines_pipeline
+
+The `kubeflowpipelines_pipeline` creates a kubeflow pipelines pipeline.
+
+To avoid deleting old related objects (runs, jobs, etc), changes in the pipeline version will upload a new version, not recreate a new pipeline object.
+
+## Example Usage
+
+```hcl-terraform
+resource "kubeflowpipelines_pipeline" "example" {
+	name        = "example"
+	description = "Description"
+	file_base64 = base64encode(file("${path.module}/pipeline.yaml"))
+	file_format = "yaml"
+	version     = "v0.0.1"
+}
+
+resource "kubeflowpipelines_pipeline" "example_url" {
+	name    = "example-with-url"
+	url     = "https://raw.githubusercontent.com/datarootsio/terraform-provider-kubeflowpipelines/master/tests/kubeflow_setup/pipeline.yaml"
+	version = "v0.0.1"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+### Required arguments
+* `name` — (Required).
+
+### Optional arguments
+
+* `description` — (Optional, conflicts with `url`). A description for the pipeline. Descriptions are ignored by the API for URL based pipelines so it's currently conflicting
+* `url` — (Optional, conflicts with `file_base64`). The URL containing a pipeline definition
+* `file_base64` — (Optional, conflicts with `url`). A base64 encoded pipeline.
+* `file_format` — (Optional, required with `file_base64`). The format of the pipeline. One of `zip`,`tar.gz`,`yaml`
+* `version` — (Optional). The version of the pipeline.
+
+## Attributes Reference
+
+The following attribute is exported:
+
+* `version_id` — The pipeline's version ID.

docs/resources/run.md

@@ -0,0 +1,46 @@
+# kubeflowpipelines_run
+
+The `kubeflowpipelines_run` creates a kubeflow pipelines run
+
+## Example Usage
+
+```hcl-terraform
+resource "kubeflowpipelines_run" "example" {
+    name            = "example"
+    description     = "Description"
+    service_account = "pipeline-runner"
+    experiment_id   = kubeflowpipelines_experiment.example.id
+    pipeline_spec {
+        pipeline_version_id = kubeflowpipelines_pipeline.example.version_id
+        parameters = {
+            "key" = "value"
+        }
+    }
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+### Required arguments
+* `name` — (Required).
+* `pipeline_spec` — (Required). The pipeline specification of this run.
+
+### Optional arguments
+
+* `description` — (Optional). A description for the run.
+* `service_account` — (Optional). The service account to attach this run to.
+* `experiment_id` — (Optional). The experiment that will store this run.
+
+### Nested Blocks
+
+#### pipeline_spec
+
+* `pipeline_version_id` — (Required). The pipeline version ID associated to this run.
+* `parameters` — (Optional). A map of key values of parameters.
+
+## Attributes Reference
+
+The following attribute is exported:
+
+* `created_at` — The date and time of creation, formatted with RFC3339.

kubeflowpipelines/resource_job.go

@@ -63,7 +63,7 @@ func resourceKubeflowPipelinesJob() *schema.Resource {
 			"no_catchup": {
 				Type:     schema.TypeBool,
 				Optional: true,
-				Default:  false,
+				Default:  true,
 				ForceNew: true,
 			},
 			"pipeline_spec": {

kubeflowpipelines/resource_job_test.go

@@ -91,9 +91,9 @@ resource "kubeflowpipelines_job" "test" {
 	}
 	trigger {
 		cron_schedule {
-		start_time = "2020-06-23T00:00:00Z"
-		end_time   = "2030-06-23T00:00:00Z"
-		cron       = "0 10 * * *"
+            start_time = "2020-06-23T00:00:00Z"
+            end_time   = "2030-06-23T00:00:00Z"
+            cron       = "0 10 * * *"
 		}
 	}
 }