Merge pull request #71 from philips-software/feature/function-updates

Refactor hsdp_function for improved update mechanism

Author: loafoe

docs/guides/functions.md

@@ -121,18 +121,34 @@ option. To achieve this the gateway runs an internal CRON scheduler which is dri
 in the Iron.io backend, syncing the config every few seconds.
 
 ```hcl
-schedule {
-    cron = "14 15 * * *"
-    timeout = 900
+resource "hsdp_function" "cuda_test" {
+  name         = "cuda-test"
+  docker_image = "philipslabs/hsdp-task-cuda-test:v0.0.5"
+  command      = ["/app/cudatest"]
+
+  schedule = "14 15 * * * *"
+  timeout  = 120
+
+  backend {
+    credentials = module.siderite_backend.credentials
   }
+}
 ```
 The above example would queue your `hsdp_function` every day at exactly 3.14pm.
 The following one would queue your function every Sunday morning at 5am:
 
 ```hcl
-schedule {
-   cron = "0 5 * * 0"
-   timeout = 1800
+resource "hsdp_function" "cuda_test" {
+  name         = "cuda-test"
+  docker_image = "philipslabs/hsdp-task-cuda-test:v0.0.4"
+  command      = ["/app/cudatest"]
+
+  schedule = "0 5 * * * 0"
+  timeout  = 120
+
+  backend {
+    credentials = module.siderite_backend.credentials
+  }
 }
 ```
 
@@ -142,12 +158,20 @@ Iron cluster, so the exact start time is always determined by how busy the clust
 Finally, an example of using the Iron.io native scheduler:
 
 ```hcl
-schedule {
-  run_every = "1d"
+resource "hsdp_function" "cuda_test" {
+  name         = "cuda-test"
+  docker_image = "philipslabs/hsdp-task-cuda-test:v0.0.5"
+  command      = ["/app/cudatest"]
+
+  run_every = "20m"
+  timeout  = 120
+
+  backend {
+    credentials = module.siderite_backend.credentials
+  }
 }
 ```
-This will run your function once every day, the time of day however depends on when Terraform deployed
-your function.
+This will run your function every 20 minutes.
 
 -> Always set a timeout value for your scheduled function. This sets a limit on the runtime for each invocation.
 

docs/index.md

@@ -51,7 +51,7 @@ The following arguments are supported:
 
 * `secret_key` - (Optional) The secret key as provided by HSDP. Actions which require API signing will not work if this value is missing.
 
-* `cartel_host` - (Optional) The cartel host as provided by HSDP. Auto-discovered when region and environment are specified.
+* `cartel_host` - (Optional) The cartel host as provided by HSDP. Auto-discovered when region is specified.
 
 * `cartel_token` - (Optional) The cartel token as provided by HSDP.
 

docs/resources/function.md

@@ -1,6 +1,6 @@
 # hsdp_function
 
-Define function-as-a-service using various backends. Currently
+Define function-as-a-service using various backends. Currently,
 only `siderite` (HSDP Iron) is supported.
 
 ## Example usage
@@ -11,7 +11,7 @@ resource "hsdp_function" "rds_backup" {
   
   # The docker packaged function business logic
   docker_image = var.streaming_backup_image
-  docker_credentails = {
+  docker_credentials = {
     username = var.docker_username
     password = var.docker_password
   }
@@ -51,22 +51,19 @@ The following arguments are supported:
   * `password` - (Required) The registry password  
 * `command` - (Optional) The command to execute in the container. Default is `/app/server`
 * `environment` - (Optional, map) The environment variables to set in the docker container before executing the function
-* `schedule` - (Optional) Schedule the function. When not set, the function becomes a task.
-  * `start` - (Optional, RFC3339) When to start the schedule. Example: `2021-01-01T04:00:00Z`. Default is a date in the past.
-  Setting the start argument allows you to control the specific time within the day when your task will be scheduled. 
-  * `run_every` - (Optional) Run the function every `{value}{unit}` period. Supported units are `s`, `m`, `h`, `d` for second, minute, hours, days respectively. Conflicts with `cron`
-    Example: a value of `"20m"` would run the function every 20 minutes.
-  * `cron` - (Optional) set schedule using cron format. This requires a backend with activated gateway. Conflicts with `run_every`
-  * `timeout` - (Optional, int) When set, limits the execution time (seconds) to this value. Default: `1800` (30 minutes)
+* `schedule` - (Optional) set schedule using cron format. This requires a backend with activated gateway. Conflicts with `run_every`
+* `run_every` - (Optional) Run the function every `{value}{unit}` period. Supported units are `s`, `m`, `h`, `d` for second, minute, hours, days respectively. Conflicts with `cron`
+  Example: a value of `"20m"` would run the function every 20 minutes.
+* `timeout` - (Optional, int) When set, limits the execution time (seconds) to this value. Default: `1800` (30 minutes)
 * `backend` - (Required) The backend to use for scheduling your functions.
-  * `type` - (Required) The backend type. Only `siderite` is supported at this time.
+  * `type` - (Optional) The backend type. Only `siderite` is supported at this time. Defaults to: `siderite`
   * `credentials` - (Required, map) The backend credentials. Must be iron configuration details at this time.
 
 ## Attribute reference
 
 The following attributes are exported:
 
 * `endpoint` - The gateway endpoint where you can trigger this function
-* `async_endpoint` - The gateway endpoint where eyou can schedule the function asychnronously  
-* `token` - The token to use in case `auth_type` is set to `token`. This token must be pased in the HTTP `Authorization` header as `Token TOKENHERE`  
+* `async_endpoint` - The gateway endpoint where you can schedule the function asynchronously  
+* `token` - The token to use in case `auth_type` is set to `token`. This token must be pasted in the HTTP `Authorization` header as `Token TOKENHERE`  
 * `auth_type` - The authentication type. Possible values [`none`, `token`, `iam`]

go.mod

@@ -18,7 +18,7 @@ require (
 	github.com/mitchellh/go-testing-interface v1.14.1 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/philips-labs/siderite v0.7.0
-	github.com/philips-software/go-hsdp-api v0.38.0
+	github.com/philips-software/go-hsdp-api v0.38.1
 	github.com/pkg/errors v0.9.1
 	github.com/robfig/cron/v3 v3.0.1
 	github.com/stretchr/testify v1.7.0

go.sum

@@ -642,8 +642,8 @@ github.com/peterbourgon/diskv v2.0.1+incompatible/go.mod h1:uqqh8zWWbv1HBMNONnaR
 github.com/philhofer/fwd v1.0.0/go.mod h1:gk3iGcWd9+svBvR0sR+KPcfE+RNWozjowpeBVG3ZVNU=
 github.com/philips-labs/siderite v0.7.0 h1:Q26TwM3Er6zseFd/SwqJaay+kmGNq8b4A8DTYr1SFqE=
 github.com/philips-labs/siderite v0.7.0/go.mod h1:vELGuq6uWTRqLci6Z22kjdn+b12eJPtss+tV6/PIlSk=
-github.com/philips-software/go-hsdp-api v0.38.0 h1:rubuy15X8cXcmz8J1wkQFPsgh4ziwULjUXmZnsZuq44=
-github.com/philips-software/go-hsdp-api v0.38.0/go.mod h1:vzZX4kCmgVwuJcAmd75Yeh/tNu1dNnBRbyau7CFWsuQ=
+github.com/philips-software/go-hsdp-api v0.38.1 h1:lieY98eUNu6QbEpq9LtozFfLr0P1bAVYzOnIX2loqj4=
+github.com/philips-software/go-hsdp-api v0.38.1/go.mod h1:vzZX4kCmgVwuJcAmd75Yeh/tNu1dNnBRbyau7CFWsuQ=
 github.com/philips-software/go-hsdp-signer v1.3.0 h1:Si1voDE/GHzthmxpasPdntbu8aUW6EYJfI6gHVf7BCc=
 github.com/philips-software/go-hsdp-signer v1.3.0/go.mod h1:/QehZ/+Aks2t1TFpjhF/7ZSB8PJIIJHzLc03rOqwLw0=
 github.com/pierrec/lz4 v2.0.5+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY=