Release v0.2.12 (#281)

Signed-off-by: Salim Afiune Maya <[email protected]>
lacework · Jan 5, 2021 · 48f5f69 · 48f5f69
1 parent 1ccaa26
commit 48f5f69
Show file tree

Hide file tree

Showing 6 changed files with 137 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,29 @@
+# v0.2.12
+
+## Features
+* feat(cli): add telemetry (#278) (Salim Afiune)([5aeec3c](https://github.com/lacework/go-sdk/commit/5aeec3c51184fc7e43e1c9dc413d256c98b8c516))
+* feat(cli): pull latest agent version from S3 (Salim Afiune Maya)([63cf1ab](https://github.com/lacework/go-sdk/commit/63cf1ab82933600189904abe0b25958769a42ec9))
+* feat: add --force to agent install (Salim Afiune Maya)([6de4775](https://github.com/lacework/go-sdk/commit/6de47756973f3396b9d3f5d6e044db3308e1700a))
+* feat: verify if agent is installed on remote host (Salim Afiune Maya)([252b9a6](https://github.com/lacework/go-sdk/commit/252b9a602781a68ee88d1d0c9e14ee290c310a79))
+* feat(cli): check for known hosts and allow custom callbacks (Salim Afiune Maya)([ebedf22](https://github.com/lacework/go-sdk/commit/ebedf221f4a1569080aeaf8de1441661845d22b2))
+* feat: add AWS S3 alert channel integration (#273) (Darren)([383de18](https://github.com/lacework/go-sdk/commit/383de18bedfa1d85eb140f5b82ecb2c69ba231be))
+* feat(cli): enable agent install command (Salim Afiune Maya)([f13d58a](https://github.com/lacework/go-sdk/commit/f13d58a2bbedf7772ddd63330a4cb813f926f541))
+## Refactor
+* refactor: verify host connectivity before select token (Salim Afiune Maya)([829cf82](https://github.com/lacework/go-sdk/commit/829cf821d457e5178c13e3d98bd9f31c60be3ded))
+* refactor(api): remove automatic report trigger (#271) (Salim Afiune)([18e624f](https://github.com/lacework/go-sdk/commit/18e624f74e68fddc2f180e5e608353a824bac9b7))
+## Bug Fixes
+* fix(cli): propagate errors from install.sh (#277) (Salim Afiune)([296be65](https://github.com/lacework/go-sdk/commit/296be658d106ad84cf9a4a3ced1d4f6122ce4db8))
+* fix(cli): avoid showing unnamed tokens (Salim Afiune Maya)([7545444](https://github.com/lacework/go-sdk/commit/754544441972f73a55181a4255453f6f911f81d0))
+## Documentation Updates
+* docs: update agent install use (Salim Afiune Maya)([62195c1](https://github.com/lacework/go-sdk/commit/62195c1a2b429b02120a8d797e0debaa448016e8))
+## Other Changes
+* chore: update long desc of agent list cmd (Salim Afiune Maya)([8a24914](https://github.com/lacework/go-sdk/commit/8a2491456d361d22de4760a79abfbbb0dcc51559))
+* build: stop publishing containers to old docker repo (Salim Afiune Maya)([ea23a30](https://github.com/lacework/go-sdk/commit/ea23a3085e4c8ef35acc4fe06d3ba972be4d932a))
+* ci: send slack notifications to team alias ⭐ (Salim Afiune Maya)([5e4c0e6](https://github.com/lacework/go-sdk/commit/5e4c0e69824ef00289e4d86adecf48209709bb59))
+* ci: fix mv on non exisitent directory (#272) (Darren)([4f101cf](https://github.com/lacework/go-sdk/commit/4f101cfe8c8aeff5981264e99bdb411b548e02e9))
+* test(cli): increase agent install test coverage (#276) (Salim Afiune)([da5b4ae](https://github.com/lacework/go-sdk/commit/da5b4aea9730c55c10d541c976dcb7ccf16aca28))
+* test: fix lwrunner tests (Salim Afiune Maya)([23587cd](https://github.com/lacework/go-sdk/commit/23587cdd98c694e65a8f0791c269817ce7252d4c))
+---
 # v0.2.11
 
 ## Features

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,20 +1,60 @@
 # Release Notes
-Another day, another release. These are the release notes for the version `v0.2.11`.
+Another day, another release. These are the release notes for the version `v0.2.12`.
+
+## Install Lacework Agent On Remote Hosts
+Users can now install agents with the command:
+```
+$ lacework agent install
+```
+
+When this command is executed without any additional flag, an interactive prompt will be
+launched to help gather the necessary authentication information to access the remote host.
+
+To authenticate to the remote host with a username and password.
+```
+$ lacework agent install <host> --ssh_username <your-user> --ssh_password <secret>
+```
+
+To authenticate to the remote host with an identity file.
+
+```
+$ lacework agent install <user@host> -i /path/to/your/key
+```
+
+To provide an agent access token of your choice, use the command `lacework agent token list`,
+select a token and pass it to the agent install command using the `--token` flag.
+
+```
+$ lacework agent install <user@host> -i /path/to/your/key --token <token>
+```
+
+### Agent Install Example
+
+![lacework-cli-agent-install-release](https://user-images.githubusercontent.com/5712253/103636405-26d83100-4f07-11eb-8bcf-0784a5abd8af.gif)
 
 ## Features
-* feat(cli): daily version check (#269) (Salim Afiune)([5c15eef](https://github.com/lacework/go-sdk/commit/5c15eef84f428ec0534954babb28a3db92d5a7c5))
-* feat(api): add Webhook integration (#267) (Darren)([f32572e](https://github.com/lacework/go-sdk/commit/f32572ecdadd5c179227cd228bf1fdd7cf618763))
+* feat(cli): add telemetry (#278) (Salim Afiune)([5aeec3c](https://github.com/lacework/go-sdk/commit/5aeec3c51184fc7e43e1c9dc413d256c98b8c516))
+* feat(cli): pull latest agent version from S3 (Salim Afiune Maya)([63cf1ab](https://github.com/lacework/go-sdk/commit/63cf1ab82933600189904abe0b25958769a42ec9))
+* feat: add --force to agent install (Salim Afiune Maya)([6de4775](https://github.com/lacework/go-sdk/commit/6de47756973f3396b9d3f5d6e044db3308e1700a))
+* feat: verify if agent is installed on remote host (Salim Afiune Maya)([252b9a6](https://github.com/lacework/go-sdk/commit/252b9a602781a68ee88d1d0c9e14ee290c310a79))
+* feat(cli): check for known hosts and allow custom callbacks (Salim Afiune Maya)([ebedf22](https://github.com/lacework/go-sdk/commit/ebedf221f4a1569080aeaf8de1441661845d22b2))
+* feat: add AWS S3 alert channel integration (#273) (Darren)([383de18](https://github.com/lacework/go-sdk/commit/383de18bedfa1d85eb140f5b82ecb2c69ba231be))
+* feat(cli): enable agent install command (Salim Afiune Maya)([f13d58a](https://github.com/lacework/go-sdk/commit/f13d58a2bbedf7772ddd63330a4cb813f926f541))
 ## Refactor
-* refactor(cli): abstract rendering tables (human-readable) (#263) (Salim Afiune)([8a10b4c](https://github.com/lacework/go-sdk/commit/8a10b4cf10de03d9b4c0409e495fdd7118974b92))
+* refactor: verify host connectivity before select token (Salim Afiune Maya)([829cf82](https://github.com/lacework/go-sdk/commit/829cf821d457e5178c13e3d98bd9f31c60be3ded))
+* refactor(api): remove automatic report trigger (#271) (Salim Afiune)([18e624f](https://github.com/lacework/go-sdk/commit/18e624f74e68fddc2f180e5e608353a824bac9b7))
 ## Bug Fixes
-* fix(cli): render account mapping file correctly (#266) (Salim Afiune)([4c327d7](https://github.com/lacework/go-sdk/commit/4c327d7e6081d0f7726a1bc007b1b736a106933f))
-* fix(api): new request body for lql service (#260) (Salim Afiune)([4e2b439](https://github.com/lacework/go-sdk/commit/4e2b439ff394d632cd6ebf214da376050da46812))
-* fix(api): avoid updating AgentTokenResponse.Props (#259) (Salim Afiune)([c3fe8bc](https://github.com/lacework/go-sdk/commit/c3fe8bcc41efd995f756f97a5ffca8bb961e89e4))
+* fix(cli): propagate errors from install.sh (#277) (Salim Afiune)([296be65](https://github.com/lacework/go-sdk/commit/296be658d106ad84cf9a4a3ced1d4f6122ce4db8))
+* fix(cli): avoid showing unnamed tokens (Salim Afiune Maya)([7545444](https://github.com/lacework/go-sdk/commit/754544441972f73a55181a4255453f6f911f81d0))
 ## Documentation Updates
-* docs: update READMEs and _examples/ (#268) (Salim Afiune)([3791da0](https://github.com/lacework/go-sdk/commit/3791da01005335c34852446c57eb99e51a6d3ce1))
+* docs: update agent install use (Salim Afiune Maya)([62195c1](https://github.com/lacework/go-sdk/commit/62195c1a2b429b02120a8d797e0debaa448016e8))
 ## Other Changes
-* build: upgrade Go version to 1.15 (#265) (Salim Afiune)([06d41f5](https://github.com/lacework/go-sdk/commit/06d41f56add71f8369ffae68ea7ba5d738eb4d5b))
-* ci: update hostname from our test machine (#262) (Salim Afiune)([beb289e](https://github.com/lacework/go-sdk/commit/beb289e732c177e2f3d062d61dee5dd9f1593ce9))
+* chore: update long desc of agent list cmd (Salim Afiune Maya)([8a24914](https://github.com/lacework/go-sdk/commit/8a2491456d361d22de4760a79abfbbb0dcc51559))
+* build: stop publishing containers to old docker repo (Salim Afiune Maya)([ea23a30](https://github.com/lacework/go-sdk/commit/ea23a3085e4c8ef35acc4fe06d3ba972be4d932a))
+* ci: send slack notifications to team alias ⭐ (Salim Afiune Maya)([5e4c0e6](https://github.com/lacework/go-sdk/commit/5e4c0e69824ef00289e4d86adecf48209709bb59))
+* ci: fix mv on non exisitent directory (#272) (Darren)([4f101cf](https://github.com/lacework/go-sdk/commit/4f101cfe8c8aeff5981264e99bdb411b548e02e9))
+* test(cli): increase agent install test coverage (#276) (Salim Afiune)([da5b4ae](https://github.com/lacework/go-sdk/commit/da5b4aea9730c55c10d541c976dcb7ccf16aca28))
+* test: fix lwrunner tests (Salim Afiune Maya)([23587cd](https://github.com/lacework/go-sdk/commit/23587cdd98c694e65a8f0791c269817ce7252d4c))
 
 ## Docker Images
 * `docker pull lacework/lacework-cli:latest`

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.2.12-dev
+0.2.12
diff --git a/api/version.go b/api/version.go
diff --git a/cli/docs/lacework_agent.md b/cli/docs/lacework_agent.md
@@ -36,5 +36,6 @@ For a complete list of supported operating systems, visit:
 ### SEE ALSO
 
 * [lacework](lacework.md)	 - A tool to manage the Lacework cloud security platform.
+* [lacework agent install](lacework_agent_install.md)	 - install the datacollector agent on a remote host
 * [lacework agent token](lacework_agent_token.md)	 - manage agent access tokens
 
diff --git a/cli/docs/lacework_agent_install.md b/cli/docs/lacework_agent_install.md
@@ -0,0 +1,57 @@
+## lacework agent install
+
+install the datacollector agent on a remote host
+
+### Synopsis
+
+For single host installation of the Lacework agent via Secure Shell (SSH).
+
+When this command is executed without any additional flag, an interactive prompt will be
+launched to help gather the necessary authentication information to access the remote host.
+
+To authenticate to the remote host with a username and password.
+
+    $ lacework agent install <host> --ssh_username <your-user> --ssh_password <secret>
+
+To authenticate to the remote host with an identity file instead.
+
+    $ lacework agent install <user@host> -i /path/to/your/key
+
+To provide an agent access token of your choice, use the command 'lacework agent token list',
+select a token and pass it to the '--token' flag.
+
+    $ lacework agent install <user@host> -i /path/to/your/key --token <token>
+
+
+```
+lacework agent install <[user@]host> [flags]
+```
+
+### Options
+
+```
+      --force                  override any pre-installed agent
+  -h, --help                   help for install
+  -i, --identity_file string   identity (private key) for public key authentication (default "~/.ssh/id_rsa")
+      --ssh_password string    password for authentication
+      --ssh_username string    username to login with
+      --token string           agent access token
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --account string      account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
+  -k, --api_key string      access key id
+  -s, --api_secret string   secret access key
+      --debug               turn on debug logging
+      --json                switch commands output from human-readable to json format
+      --nocolor             turn off colors
+      --noninteractive      turn off interactive mode (disable spinners, prompts, etc.)
+  -p, --profile string      switch between profiles configured at ~/.lacework.toml
+```
+
+### SEE ALSO
+
+* [lacework agent](lacework_agent.md)	 - manage Lacework agents
+