docs: remove references to decommissioned 'integrations' cmd (#1178)

* docs: remove references to decommissioned 'integrations' cmd Signed-off-by: Darren Murray <[email protected]> * docs: run make generate-docs Signed-off-by: Darren Murray <[email protected]> --------- Signed-off-by: Darren Murray <[email protected]>
lacework · Mar 10, 2023 · aec4fe2 · aec4fe2
1 parent 06dde0a
commit aec4fe2
Show file tree

Hide file tree

Showing 86 changed files with 3,528 additions and 149 deletions.
diff --git a/DEVELOPER_GUIDELINES.md b/DEVELOPER_GUIDELINES.md
@@ -21,7 +21,7 @@ feat(cli): add --api_token global flag
 This new flag will replace the use of `api_key` and `api_secret` so that
 users can run the Lacework CLI only with an access token and their account:
 
-    lacework int list --api_token _secret123 -a mycompany
+    lacework cloud-account list --api_token _secret123 -a mycompany
 
 Closes https://github.com/lacework/go-sdk/issues/282
 ```

diff --git a/cli/cmd/compliance.go b/cli/cmd/compliance.go
@@ -76,7 +76,7 @@ HIPAA benchmark standards.
 
 Get started by integrating one or more cloud accounts using the command:
 
-    lacework integration create
+    lacework cloud-account create
 
 If you prefer to configure the integration via the WebUI, log in to your account at:
 
@@ -86,7 +86,7 @@ Then navigate to Settings > Integrations > Cloud Accounts.
 
 Use the following command to list all available integrations in your account:
 
-    lacework integrations list
+    lacework cloud-account list
 `,
 	}
 

diff --git a/cli/cmd/compliance_aws.go b/cli/cmd/compliance_aws.go
@@ -609,7 +609,7 @@ func cliListAwsAccounts(awsIntegrations api.CloudAccountsResponse) error {
 
 Get started by integrating your AWS accounts to analyze configuration compliance using the command:
 
-    lacework integration create
+    lacework cloud-account aws create
 
 If you prefer to configure the integration via the WebUI, log in to your account at:
 

diff --git a/cli/cmd/compliance_azure.go b/cli/cmd/compliance_azure.go
@@ -602,7 +602,7 @@ func cliListTenantsAndSubscriptions(azureIntegrations api.CloudAccountsResponse)
 
 Get started by integrating your Azure Tenants to analyze configuration compliance using the command:
 
-    lacework integration create
+    lacework cloud-account create
 
 If you prefer to configure the integration via the WebUI, log in to your account at:
 

diff --git a/cli/cmd/compliance_gcp.go b/cli/cmd/compliance_gcp.go
@@ -77,11 +77,11 @@ var (
 
 Use the following command to list all GCP integrations in your account:
 
-    lacework integrations list --type GCP_CFG
+    lacework cloud-account list --type GcpCfg
 
 Then, select one GUID from an integration and visualize its details using the command:
 
-    lacework integration show <int_guid>
+    lacework cloud-account show <int_guid>
 `,
 		Args: cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, args []string) error {
@@ -731,7 +731,7 @@ func cliListGcpProjectsAndOrgs(response api.CloudAccountsResponse, gcpData api.G
 
 Get started by integrating your GCP to analyze configuration compliance using the command:
 
-    lacework integration create
+    lacework cloud-account create
 
 If you prefer to configure the integration via the WebUI, log in to your account at:
 

diff --git a/cli/cmd/vulnerability.go b/cli/cmd/vulnerability.go
@@ -111,7 +111,7 @@ trying to scan or show.
 
 To create a new integration use the following command:
 
-    lacework integration create
+    lacework container-registry create
 
 If you prefer to configure the integration via the WebUI, log in to your account at:
 

diff --git a/cli/docs/lacework_agent_aws-install.md b/cli/docs/lacework_agent_aws-install.md
@@ -0,0 +1,40 @@
+---
+title: "lacework agent aws-install"
+slug: lacework_agent_aws-install
+hide_title: true
+---
+
+## lacework agent aws-install
+
+Install the datacollector agent on all remote AWS hosts
+
+### Options
+
+```
+  -h, --help   help for aws-install
+```
+
+### 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
+      --api_token string    access token (replaces the use of api_key and api_secret)
+      --debug               turn on debug logging
+      --json                switch commands output from human-readable to json format
+      --nocache             turn off caching
+      --nocolor             turn off colors
+      --noninteractive      turn off interactive mode (disable spinners, prompts, etc.)
+      --organization        access organization level data sets (org admins only)
+  -p, --profile string      switch between profiles configured at ~/.lacework.toml
+      --subaccount string   sub-account name inside your organization (org admins only)
+```
+
+### SEE ALSO
+
+* [lacework agent](lacework_agent.md)	 - Manage Lacework agents
+* [lacework agent aws-install ec2ic](lacework_agent_aws-install_ec2ic.md)	 - Use EC2InstanceConnect to securely connect to EC2 instances
+* [lacework agent aws-install ec2ssh](lacework_agent_aws-install_ec2ssh.md)	 - Use SSH to securely connect to EC2 instances
+* [lacework agent aws-install ec2ssm](lacework_agent_aws-install_ec2ssm.md)	 - Use SSM to securely install the Lacework agent on EC2 instances
+
diff --git a/cli/docs/lacework_agent_aws-install_ec2ic.md b/cli/docs/lacework_agent_aws-install_ec2ic.md
@@ -0,0 +1,87 @@
+---
+title: "lacework agent aws-install ec2ic"
+slug: lacework_agent_aws-install_ec2ic
+hide_title: true
+---
+
+## lacework agent aws-install ec2ic
+
+Use EC2InstanceConnect to securely connect to EC2 instances
+
+### Synopsis
+
+This command installs the agent on all EC2 instances in an AWS account using EC2InstanceConnect.
+
+To filter by one or more regions:
+
+    lacework agent aws-install ec2ic --include_regions us-west-2,us-east-2
+
+To filter by instance tag:
+
+    lacework agent aws-install ec2ic --tag TagName,TagValue
+
+To filter by instance tag key:
+
+    lacework agent aws-install ec2ic --tag_key TagName
+
+To explicitly specify the username for all SSH logins:
+
+    lacework agent aws-install ec2ic --ssh_username <your-user>
+
+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. This flag must be selected if the
+'--noninteractive' flag is set.
+
+    lacework agent aws-install ec2ic --token <token>
+
+AWS credentials are read from the following environment variables:
+- AWS_ACCESS_KEY_ID
+- AWS_SECRET_ACCESS_KEY
+- AWS_SESSION_TOKEN (optional)
+- AWS_REGION (optional)
+
+This command will only install the agent on hosts that are supported by
+EC2InstanceConnect. The supported AMI types are Amazon Linux 2 and Ubuntu
+16.04 and later. There may also be a region restriction.
+
+This command will automatically add hosts with successful connections to
+'~/.ssh/known_hosts' unless specified with '--trust_host_key=false'.
+
+```
+lacework agent aws-install ec2ic [flags]
+```
+
+### Options
+
+```
+  -h, --help                      help for ec2ic
+  -r, --include_regions strings   list of regions to filter on
+  -n, --max_parallelism int       maximum number of workers executing AWS API calls, set if rate limits are lower or higher than normal (default 50)
+      --ssh_username string       username to login with
+      --tag strings               only install agents on infra with this tag
+      --tag_key string            only install agents on infra with this tag key set
+      --token string              agent access token
+      --trust_host_key            automatically add host keys to the ~/.ssh/known_hosts file (default true)
+```
+
+### 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
+      --api_token string    access token (replaces the use of api_key and api_secret)
+      --debug               turn on debug logging
+      --json                switch commands output from human-readable to json format
+      --nocache             turn off caching
+      --nocolor             turn off colors
+      --noninteractive      turn off interactive mode (disable spinners, prompts, etc.)
+      --organization        access organization level data sets (org admins only)
+  -p, --profile string      switch between profiles configured at ~/.lacework.toml
+      --subaccount string   sub-account name inside your organization (org admins only)
+```
+
+### SEE ALSO
+
+* [lacework agent aws-install](lacework_agent_aws-install.md)	 - Install the datacollector agent on all remote AWS hosts
+
diff --git a/cli/docs/lacework_agent_aws-install_ec2ssh.md b/cli/docs/lacework_agent_aws-install_ec2ssh.md
@@ -0,0 +1,95 @@
+---
+title: "lacework agent aws-install ec2ssh"
+slug: lacework_agent_aws-install_ec2ssh
+hide_title: true
+---
+
+## lacework agent aws-install ec2ssh
+
+Use SSH to securely connect to EC2 instances
+
+### Synopsis
+
+This command installs the agent on all EC2 instances in an AWS account
+using SSH.
+
+To filter by one or more regions:
+
+    lacework agent aws-install ec2ssh --include_regions us-west-2,us-east-2
+
+To filter by instance tag:
+
+    lacework agent aws-install ec2ssh --tag TagName,TagValue
+
+To filter by instance tag key:
+
+    lacework agent aws-install ec2ssh --tag_key TagName
+
+To provide an existing access token, use the '--token' flag. This flag is required
+when running non-interactively ('--noninteractive' flag). The interactive command
+'lacework agent token list' can be used to query existing tokens.
+
+    lacework agent aws-install ec2ic --token <token>
+
+You will need to provide an SSH authentication method. This authentication method
+should work for all instances that your tag or region filters select. Instances must
+be routable from your local host.
+
+To authenticate using username and password:
+
+    lacework agent aws-install ec2ssh --ssh_username <your-user> --ssh_password <secret>
+
+To authenticate using an identity file:
+
+    lacework agent aws-install ec2ssh -i /path/to/your/key
+
+The environment should contain AWS credentials in the following variables:
+- AWS_ACCESS_KEY_ID
+- AWS_SECRET_ACCESS_KEY
+- AWS_SESSION_TOKEN (optional),
+- AWS_REGION (optional)
+
+This command will automatically add hosts with successful connections to
+'~/.ssh/known_hosts' unless specified with '--trust_host_key=false'.
+
+```
+lacework agent aws-install ec2ssh [flags]
+```
+
+### Options
+
+```
+  -h, --help                      help for ec2ssh
+  -i, --identity_file string      identity (private key) for public key authentication (default "~/.ssh/id_rsa")
+  -r, --include_regions strings   list of regions to filter on
+  -n, --max_parallelism int       maximum number of workers executing AWS API calls, set if rate limits are lower or higher than normal (default 50)
+      --ssh_password string       password for authentication
+      --ssh_port int              port to connect to on the remote host (default 22)
+      --ssh_username string       username to login with
+      --tag strings               only select instances with this tag
+      --tag_key string            only install agents on infra with this tag key
+      --token string              agent access token
+      --trust_host_key            automatically add host keys to the ~/.ssh/known_hosts file (default true)
+```
+
+### 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
+      --api_token string    access token (replaces the use of api_key and api_secret)
+      --debug               turn on debug logging
+      --json                switch commands output from human-readable to json format
+      --nocache             turn off caching
+      --nocolor             turn off colors
+      --noninteractive      turn off interactive mode (disable spinners, prompts, etc.)
+      --organization        access organization level data sets (org admins only)
+  -p, --profile string      switch between profiles configured at ~/.lacework.toml
+      --subaccount string   sub-account name inside your organization (org admins only)
+```
+
+### SEE ALSO
+
+* [lacework agent aws-install](lacework_agent_aws-install.md)	 - Install the datacollector agent on all remote AWS hosts
+