- Notifications
You must be signed in to change notification settings - Fork23
feat: addcoder_script#154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "coder_script Resource - terraform-provider-coder" | ||
| subcategory: "" | ||
| description: |- | ||
| Use this resource to run a script from an agent. | ||
| --- | ||
| # coder_script (Resource) | ||
| Use this resource to run a script from an agent. | ||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
| ### Required | ||
| - `agent_id` (String) The "id" property of a "coder_agent" resource to associate with. | ||
| - `display_name` (String) The display name of the script to display logs in the dashboard. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Same for IMO, a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I have a nice UI mock that displays this! | ||
| - `script` (String) The script to run. | ||
| ### Optional | ||
| - `cron` (String) The cron schedule to run the script on. This is a cron expression. | ||
| - `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Why do we have icon? Do we want to display all of them on the dashboard? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Yes. These scripts will be displayed in the dashboard. | ||
| - `log_path` (String) The path of a file to write the logs to. If relative, it will be appended to tmp. | ||
| - `run_on_start` (Boolean) This option defines whether or not the script should run when the agent starts. | ||
| - `run_on_stop` (Boolean) This option defines whether or not the script should run when the agent stops. | ||
| - `start_blocks_login` (Boolean) This option defines whether or not the user can (by default) login to the workspace before this script completes running on start. When enabled, users may see an incomplete workspace when logging in. | ||
| - `timeout` (Number) Time in seconds until the agent lifecycle status is marked as timed out, this happens when the script has not completed (exited) in the given time. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Can you document what you set this to if it's a long-running process? Or I guess we want people to ampersand things There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I'm going to allow long-running operations that consistently log, so I'll update this. | ||
| ### Read-Only | ||
| - `id` (String) The ID of this resource. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| package provider | ||
| import ( | ||
| "context" | ||
| "github.com/google/uuid" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" | ||
| ) | ||
| func scriptResource() *schema.Resource { | ||
| return &schema.Resource{ | ||
| Description: "Use this resource to run a script from an agent.", | ||
| CreateContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics { | ||
| rd.SetId(uuid.NewString()) | ||
| return nil | ||
| }, | ||
| ReadContext: schema.NoopContext, | ||
| DeleteContext: schema.NoopContext, | ||
| Schema: map[string]*schema.Schema{ | ||
| "agent_id": { | ||
| Type: schema.TypeString, | ||
| Description: `The "id" property of a "coder_agent" resource to associate with.`, | ||
| ForceNew: true, | ||
| Required: true, | ||
| }, | ||
| "display_name": { | ||
| Type: schema.TypeString, | ||
| Description: "The display name of the script to display logs in the dashboard.", | ||
| ForceNew: true, | ||
| Required: true, | ||
| }, | ||
| "log_path": { | ||
| Type: schema.TypeString, | ||
| Description: "The path of a file to write the logs to. If relative, it will be appended to tmp.", | ||
| ForceNew: true, | ||
| Optional: true, | ||
| }, | ||
| "icon": { | ||
| Type: schema.TypeString, | ||
| ForceNew: true, | ||
| Optional: true, | ||
| Description: "A URL to an icon that will display in the dashboard. View built-in " + | ||
| "icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a " + | ||
| "built-in icon with `data.coder_workspace.me.access_url + \"/icon/<path>\"`.", | ||
| }, | ||
| "script": { | ||
| ForceNew: true, | ||
| Type: schema.TypeString, | ||
| Required: true, | ||
| Description: "The script to run.", | ||
| }, | ||
| "cron": { | ||
| ForceNew: true, | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Description: "The cron schedule to run the script on. This is a cron expression.", | ||
| }, | ||
| "start_blocks_login": { | ||
| Type: schema.TypeBool, | ||
| Default: false, | ||
| ForceNew: true, | ||
| Optional: true, | ||
| Description: "This option defines whether or not the user can (by default) login to the workspace before this script completes running on start. When enabled, users may see an incomplete workspace when logging in.", | ||
| }, | ||
| "run_on_start": { | ||
| Type: schema.TypeBool, | ||
| Default: false, | ||
| ForceNew: true, | ||
| Optional: true, | ||
| Description: "This option defines whether or not the script should run when the agent starts.", | ||
| }, | ||
| "run_on_stop": { | ||
| Type: schema.TypeBool, | ||
| Default: false, | ||
| ForceNew: true, | ||
| Optional: true, | ||
| Description: "This option defines whether or not the script should run when the agent stops.", | ||
| }, | ||
| "timeout": { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. For cron jobs that use There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Yes. You'd want to add a very lengthy timeout in that case, or not have one at all. Right now, when two CRONs overlap, the prior process won't end. | ||
| Type: schema.TypeInt, | ||
| Default: 0, | ||
| ForceNew: true, | ||
| Optional: true, | ||
| Description: "Time in seconds until the agent lifecycle status is marked as timed out, this happens when the script has not completed (exited) in the given time.", | ||
| ValidateFunc: validation.IntAtLeast(1), | ||
| }, | ||
| }, | ||
| } | ||
| } | ||