Skip to content

fix: Improve connection_timeout docs and add validation #72

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mafredri merged 2 commits into from
Dec 19, 2022
Merged

fix: Improve connection_timeout docs and add validation #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
258c32d
fix: Improve connection_timeout docs and add validation
mafredri Nov 9, 2022
12c83f3
Merge branch 'main' into mafredri/improve-connection-timeout-docs
mafredri Dec 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/resources/agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ resource "kubernetes_pod" "dev" {
### Optional

- `auth` (String) The authentication type the agent will use. Must be one of: "token", "google-instance-identity", "aws-instance-identity", "azure-instance-identity".
- `connection_timeout` (Number) Time in seconds until the agent is marked as timed out when a connection with the server cannot be established.
- `connection_timeout` (Number) Time in seconds until the agent is marked as timed out when a connection with the server cannot be established. A value of zero never marks the agent as timed out.
- `dir` (String) The starting directory when a user creates a shell session. Defaults to $HOME.
- `env` (Map of String) A mapping of environment variables to set inside the workspace.
- `motd_file` (String) The path to a file within the workspace containing a message to display to users when they login via SSH. A typical value would be /etc/motd.
Expand Down
11 changes: 6 additions & 5 deletions provider/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,12 @@ func agentResource() *schema.Resource {
Computed: true,
},
"connection_timeout": {
Type: schema.TypeInt,
Default: 120,
ForceNew: true,
Optional: true,
Description: "Time in seconds until the agent is marked as timed out when a connection with the server cannot be established.",
Type: schema.TypeInt,
Default: 120,
ForceNew: true,
Optional: true,
Description: "Time in seconds until the agent is marked as timed out when a connection with the server cannot be established. A value of zero never marks the agent as timed out.",
ValidateFunc: validation.IntAtLeast(0),
},
"troubleshooting_url": {
Type: schema.TypeString,
Expand Down