Add docs about tsuru_app_deploy

tsuru · Jan 25, 2023 · df44c6b · df44c6b
1 parent a33abc9
commit df44c6b
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 9 deletions.
diff --git a/docs/resources/app_deploy.md b/docs/resources/app_deploy.md
@@ -3,14 +3,21 @@
 page_title: "tsuru_app_deploy Resource - terraform-provider-tsuru"
 subcategory: ""
 description: |-
-  Tsuru Application Deploy
+  Do a deployment for an application, that currently only supports deploys via prebuilt docker images, to do deploys via tsuru platforms please use tsuru-client
 ---
 
 # tsuru_app_deploy (Resource)
 
-Tsuru Application Deploy
+Do a deployment for an application, that currently only supports deploys via prebuilt docker images, to do deploys via tsuru platforms please use tsuru-client
 
+## Example Usage
 
+```terraform
+resource "tsuru_app_deploy" "my-deploy" {
+  app   = tsuru_app.my-app.name
+  image = "myrepository/my-app:0.1.0"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -30,8 +37,8 @@ Tsuru Application Deploy
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `output_image` (String)
-- `status` (String)
+- `output_image` (String) Image generated after success of deploy
+- `status` (String) after apply may be three kinds of statuses: running or failed or finished
 
 <a id="nestedblock--timeouts"></a>
 ### Nested Schema for `timeouts`

diff --git a/examples/resources/tsuru_app_deploy/resource.tf b/examples/resources/tsuru_app_deploy/resource.tf
@@ -0,0 +1,4 @@
+resource "tsuru_app_deploy" "my-deploy" {
+  app   = tsuru_app.my-app.name
+  image = "myrepository/my-app:0.1.0"
+}
diff --git a/internal/provider/resource_tsuru_app_deploy.go b/internal/provider/resource_tsuru_app_deploy.go
@@ -26,7 +26,7 @@ import (
 
 func resourceTsuruApplicationDeploy() *schema.Resource {
 	return &schema.Resource{
-		Description:   "Tsuru Application Deploy",
+		Description:   "Do a deployment for an application, that currently only supports deploys via prebuilt docker images, to do deploys via tsuru platforms please use tsuru-client",
 		CreateContext: resourceTsuruApplicationDeployDo,
 		UpdateContext: resourceTsuruApplicationDeployDo,
 		ReadContext:   resourceTsuruApplicationDeployRead,
@@ -71,13 +71,15 @@ func resourceTsuruApplicationDeploy() *schema.Resource {
 			},
 
 			"status": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Description: "after apply may be three kinds of statuses: running or failed or finished",
+				Computed:    true,
 			},
 
 			"output_image": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Description: "Image generated after success of deploy",
+				Computed:    true,
 			},
 		},
 	}