Add docstrings
This commit is contained in:
parent
d384ad7f7b
commit
3c7b60de2e
1 changed files with 17 additions and 0 deletions
|
@ -35,16 +35,33 @@
|
||||||
; which will happen if this is run after terragrunt
|
; which will happen if this is run after terragrunt
|
||||||
; but it is not guaranteed
|
; but it is not guaranteed
|
||||||
(defn-spec generate-jar! nil?
|
(defn-spec generate-jar! nil?
|
||||||
|
"Generates c4k app yaml using 'c4k-{module}-standalone.jar'
|
||||||
|
Stores the result in 'c4k-app.yaml'
|
||||||
|
|
||||||
|
Defaults: c4k-config.yaml c4k-auth.yaml c4k-app.yaml
|
||||||
|
can be changed by adding another value for ':c4k-config-filename', ':c4k-auth-filename', ':c4k-output-filename'
|
||||||
|
"
|
||||||
[devops ::d/devops]
|
[devops ::d/devops]
|
||||||
(let [config (merge default devops)]
|
(let [config (merge default devops)]
|
||||||
(run-c4k-jar! config)))
|
(run-c4k-jar! config)))
|
||||||
|
|
||||||
(defn-spec generate! nil?
|
(defn-spec generate! nil?
|
||||||
|
"Generates c4k app yaml using 'c4k-{module}' (graalvm executable)
|
||||||
|
Stores the result in 'c4k-app.yaml'
|
||||||
|
|
||||||
|
Defaults: c4k-config.yaml c4k-auth.yaml c4k-app.yaml
|
||||||
|
can be changed by adding another value for ':c4k-config-filename', ':c4k-auth-filename', ':c4k-output-filename'
|
||||||
|
"
|
||||||
[devops ::d/devops]
|
[devops ::d/devops]
|
||||||
(let [config (merge default devops)]
|
(let [config (merge default devops)]
|
||||||
(run-c4k-executable! config)))
|
(run-c4k-executable! config)))
|
||||||
|
|
||||||
(defn-spec insert-tf-out! nil?
|
(defn-spec insert-tf-out! nil?
|
||||||
|
"Inserts relevant values from the tf output into the c4k config
|
||||||
|
|
||||||
|
Default: c4k-config.yaml
|
||||||
|
can be changed by adding another value for ':c4k-config-filename'
|
||||||
|
"
|
||||||
[devops ::d/devops
|
[devops ::d/devops
|
||||||
tf-out ::domain/tf-out]
|
tf-out ::domain/tf-out]
|
||||||
(let [config (merge default devops)
|
(let [config (merge default devops)
|
||||||
|
|
Loading…
Reference in a new issue