From 4b018a484cb5110d42dfdd750a80038bdf2e338d Mon Sep 17 00:00:00 2001 From: miyamo2 Date: Thu, 21 Nov 2024 06:44:28 +0900 Subject: [PATCH] doc: v0.1.0 --- CHANGELOG.md | 5 +++++ README.md | 13 +++++++++++++ cmd/create_transient_configmap.go | 2 +- 3 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9470cb0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 0.1.0 - 2024-11-20 + +### 🎉Initial Release diff --git a/README.md b/README.md index 13554d3..6258b04 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,19 @@ spec: kubectl create transient_configmap my-config --from-literal=num=1 --job-name=test-job --job-from=cronjob/a-cronjob ``` +## Features + +### Flags + +| name | description | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `from-env-file` | Specify the path to a file to read lines of key=val pairs to create a configmap. | +| `from-file` | Key file can be specified using its file path, in which case file basename will be used as configmap key, or optionally with a key and file path, in which case the given key will be used. Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key. | +| `from-literal` | Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) | +| `job-name` | Name of job to be created. required. | +| `job-from` | The name of the resource to create a Job from (only cronjob is supported). | +| `job-image` | Image name to run. | + ## Contributing Feel free to open a PR or an Issue. diff --git a/cmd/create_transient_configmap.go b/cmd/create_transient_configmap.go index 47cbb4c..655b74d 100644 --- a/cmd/create_transient_configmap.go +++ b/cmd/create_transient_configmap.go @@ -32,7 +32,7 @@ import ( "strings" ) -const version = "0.1.0-alpha" +const version = "0.1.0" var ( // transientConfigMapUse is the one-line usage message for the transient_configmap command