Skip to content

Commit aec4fe2

Browse files
dmurray-laceworkdmurray-lacework
authored
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]>
1 parent 06dde0a commit aec4fe2

File tree

86 files changed

+3528
-149
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+3528
-149
lines changed

‎DEVELOPER_GUIDELINES.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ feat(cli): add --api_token global flag
2121
This new flag will replace the use of `api_key` and `api_secret` so that
2222
users can run the Lacework CLI only with an access token and their account:
2323
24-
lacework int list --api_token _secret123 -a mycompany
24+
lacework cloud-account list --api_token _secret123 -a mycompany
2525
2626
Closes https://github.com/lacework/go-sdk/issues/282
2727
```

‎cli/cmd/compliance.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ HIPAA benchmark standards.
7676
7777
Get started by integrating one or more cloud accounts using the command:
7878
79-
lacework integration create
79+
lacework cloud-account create
8080
8181
If you prefer to configure the integration via the WebUI, log in to your account at:
8282
@@ -86,7 +86,7 @@ Then navigate to Settings > Integrations > Cloud Accounts.
8686
8787
Use the following command to list all available integrations in your account:
8888
89-
lacework integrations list
89+
lacework cloud-account list
9090
`,
9191
}
9292

‎cli/cmd/compliance_aws.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ func cliListAwsAccounts(awsIntegrations api.CloudAccountsResponse) error {
609609
610610
Get started by integrating your AWS accounts to analyze configuration compliance using the command:
611611
612-
lacework integration create
612+
lacework cloud-account aws create
613613
614614
If you prefer to configure the integration via the WebUI, log in to your account at:
615615

‎cli/cmd/compliance_azure.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ func cliListTenantsAndSubscriptions(azureIntegrations api.CloudAccountsResponse)
602602
603603
Get started by integrating your Azure Tenants to analyze configuration compliance using the command:
604604
605-
lacework integration create
605+
lacework cloud-account create
606606
607607
If you prefer to configure the integration via the WebUI, log in to your account at:
608608

‎cli/cmd/compliance_gcp.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ var (
7777
7878
Use the following command to list all GCP integrations in your account:
7979
80-
lacework integrations list --type GCP_CFG
80+
lacework cloud-account list --type GcpCfg
8181
8282
Then, select one GUID from an integration and visualize its details using the command:
8383
84-
lacework integration show <int_guid>
84+
lacework cloud-account show <int_guid>
8585
`,
8686
Args: cobra.ExactArgs(1),
8787
RunE: func(_ *cobra.Command, args []string) error {
@@ -731,7 +731,7 @@ func cliListGcpProjectsAndOrgs(response api.CloudAccountsResponse, gcpData api.G
731731
732732
Get started by integrating your GCP to analyze configuration compliance using the command:
733733
734-
lacework integration create
734+
lacework cloud-account create
735735
736736
If you prefer to configure the integration via the WebUI, log in to your account at:
737737

‎cli/cmd/vulnerability.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ trying to scan or show.
111111
112112
To create a new integration use the following command:
113113
114-
lacework integration create
114+
lacework container-registry create
115115
116116
If you prefer to configure the integration via the WebUI, log in to your account at:
117117

‎cli/docs/lacework_agent_aws-install.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "lacework agent aws-install"
3+
slug: lacework_agent_aws-install
4+
hide_title: true
5+
---
6+
7+
## lacework agent aws-install
8+
9+
Install the datacollector agent on all remote AWS hosts
10+
11+
### Options
12+
13+
```
14+
-h, --help help for aws-install
15+
```
16+
17+
### Options inherited from parent commands
18+
19+
```
20+
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
21+
-k, --api_key string access key id
22+
-s, --api_secret string secret access key
23+
--api_token string access token (replaces the use of api_key and api_secret)
24+
--debug turn on debug logging
25+
--json switch commands output from human-readable to json format
26+
--nocache turn off caching
27+
--nocolor turn off colors
28+
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
29+
--organization access organization level data sets (org admins only)
30+
-p, --profile string switch between profiles configured at ~/.lacework.toml
31+
--subaccount string sub-account name inside your organization (org admins only)
32+
```
33+
34+
### SEE ALSO
35+
36+
* [lacework agent](lacework_agent.md) - Manage Lacework agents
37+
* [lacework agent aws-install ec2ic](lacework_agent_aws-install_ec2ic.md) - Use EC2InstanceConnect to securely connect to EC2 instances
38+
* [lacework agent aws-install ec2ssh](lacework_agent_aws-install_ec2ssh.md) - Use SSH to securely connect to EC2 instances
39+
* [lacework agent aws-install ec2ssm](lacework_agent_aws-install_ec2ssm.md) - Use SSM to securely install the Lacework agent on EC2 instances
40+

‎cli/docs/lacework_agent_aws-install_ec2ic.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: "lacework agent aws-install ec2ic"
3+
slug: lacework_agent_aws-install_ec2ic
4+
hide_title: true
5+
---
6+
7+
## lacework agent aws-install ec2ic
8+
9+
Use EC2InstanceConnect to securely connect to EC2 instances
10+
11+
### Synopsis
12+
13+
This command installs the agent on all EC2 instances in an AWS account using EC2InstanceConnect.
14+
15+
To filter by one or more regions:
16+
17+
lacework agent aws-install ec2ic --include_regions us-west-2,us-east-2
18+
19+
To filter by instance tag:
20+
21+
lacework agent aws-install ec2ic --tag TagName,TagValue
22+
23+
To filter by instance tag key:
24+
25+
lacework agent aws-install ec2ic --tag_key TagName
26+
27+
To explicitly specify the username for all SSH logins:
28+
29+
lacework agent aws-install ec2ic --ssh_username <your-user>
30+
31+
To provide an agent access token of your choice, use the command 'lacework agent token list',
32+
select a token and pass it to the '--token' flag. This flag must be selected if the
33+
'--noninteractive' flag is set.
34+
35+
lacework agent aws-install ec2ic --token <token>
36+
37+
AWS credentials are read from the following environment variables:
38+
- AWS_ACCESS_KEY_ID
39+
- AWS_SECRET_ACCESS_KEY
40+
- AWS_SESSION_TOKEN (optional)
41+
- AWS_REGION (optional)
42+
43+
This command will only install the agent on hosts that are supported by
44+
EC2InstanceConnect. The supported AMI types are Amazon Linux 2 and Ubuntu
45+
16.04 and later. There may also be a region restriction.
46+
47+
This command will automatically add hosts with successful connections to
48+
'~/.ssh/known_hosts' unless specified with '--trust_host_key=false'.
49+
50+
```
51+
lacework agent aws-install ec2ic [flags]
52+
```
53+
54+
### Options
55+
56+
```
57+
-h, --help help for ec2ic
58+
-r, --include_regions strings list of regions to filter on
59+
-n, --max_parallelism int maximum number of workers executing AWS API calls, set if rate limits are lower or higher than normal (default 50)
60+
--ssh_username string username to login with
61+
--tag strings only install agents on infra with this tag
62+
--tag_key string only install agents on infra with this tag key set
63+
--token string agent access token
64+
--trust_host_key automatically add host keys to the ~/.ssh/known_hosts file (default true)
65+
```
66+
67+
### Options inherited from parent commands
68+
69+
```
70+
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
71+
-k, --api_key string access key id
72+
-s, --api_secret string secret access key
73+
--api_token string access token (replaces the use of api_key and api_secret)
74+
--debug turn on debug logging
75+
--json switch commands output from human-readable to json format
76+
--nocache turn off caching
77+
--nocolor turn off colors
78+
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
79+
--organization access organization level data sets (org admins only)
80+
-p, --profile string switch between profiles configured at ~/.lacework.toml
81+
--subaccount string sub-account name inside your organization (org admins only)
82+
```
83+
84+
### SEE ALSO
85+
86+
* [lacework agent aws-install](lacework_agent_aws-install.md) - Install the datacollector agent on all remote AWS hosts
87+

‎cli/docs/lacework_agent_aws-install_ec2ssh.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: "lacework agent aws-install ec2ssh"
3+
slug: lacework_agent_aws-install_ec2ssh
4+
hide_title: true
5+
---
6+
7+
## lacework agent aws-install ec2ssh
8+
9+
Use SSH to securely connect to EC2 instances
10+
11+
### Synopsis
12+
13+
This command installs the agent on all EC2 instances in an AWS account
14+
using SSH.
15+
16+
To filter by one or more regions:
17+
18+
lacework agent aws-install ec2ssh --include_regions us-west-2,us-east-2
19+
20+
To filter by instance tag:
21+
22+
lacework agent aws-install ec2ssh --tag TagName,TagValue
23+
24+
To filter by instance tag key:
25+
26+
lacework agent aws-install ec2ssh --tag_key TagName
27+
28+
To provide an existing access token, use the '--token' flag. This flag is required
29+
when running non-interactively ('--noninteractive' flag). The interactive command
30+
'lacework agent token list' can be used to query existing tokens.
31+
32+
lacework agent aws-install ec2ic --token <token>
33+
34+
You will need to provide an SSH authentication method. This authentication method
35+
should work for all instances that your tag or region filters select. Instances must
36+
be routable from your local host.
37+
38+
To authenticate using username and password:
39+
40+
lacework agent aws-install ec2ssh --ssh_username <your-user> --ssh_password <secret>
41+
42+
To authenticate using an identity file:
43+
44+
lacework agent aws-install ec2ssh -i /path/to/your/key
45+
46+
The environment should contain AWS credentials in the following variables:
47+
- AWS_ACCESS_KEY_ID
48+
- AWS_SECRET_ACCESS_KEY
49+
- AWS_SESSION_TOKEN (optional),
50+
- AWS_REGION (optional)
51+
52+
This command will automatically add hosts with successful connections to
53+
'~/.ssh/known_hosts' unless specified with '--trust_host_key=false'.
54+
55+
```
56+
lacework agent aws-install ec2ssh [flags]
57+
```
58+
59+
### Options
60+
61+
```
62+
-h, --help help for ec2ssh
63+
-i, --identity_file string identity (private key) for public key authentication (default "~/.ssh/id_rsa")
64+
-r, --include_regions strings list of regions to filter on
65+
-n, --max_parallelism int maximum number of workers executing AWS API calls, set if rate limits are lower or higher than normal (default 50)
66+
--ssh_password string password for authentication
67+
--ssh_port int port to connect to on the remote host (default 22)
68+
--ssh_username string username to login with
69+
--tag strings only select instances with this tag
70+
--tag_key string only install agents on infra with this tag key
71+
--token string agent access token
72+
--trust_host_key automatically add host keys to the ~/.ssh/known_hosts file (default true)
73+
```
74+
75+
### Options inherited from parent commands
76+
77+
```
78+
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
79+
-k, --api_key string access key id
80+
-s, --api_secret string secret access key
81+
--api_token string access token (replaces the use of api_key and api_secret)
82+
--debug turn on debug logging
83+
--json switch commands output from human-readable to json format
84+
--nocache turn off caching
85+
--nocolor turn off colors
86+
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
87+
--organization access organization level data sets (org admins only)
88+
-p, --profile string switch between profiles configured at ~/.lacework.toml
89+
--subaccount string sub-account name inside your organization (org admins only)
90+
```
91+
92+
### SEE ALSO
93+
94+
* [lacework agent aws-install](lacework_agent_aws-install.md) - Install the datacollector agent on all remote AWS hosts
95+

0 commit comments

Comments
 (0)