Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Isan-Rivkin committed Sep 16, 2024
1 parent f724e6a commit 5d2a2f7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,38 @@ The Supported resource types are auto generated into the code during every build

**List Supported resource types**

Note: certain resources require additional fields to be specified, such as `AWS::EKS::Addon`
And list-types will show the required fields (e.g `ClusterName`).

```bash
surf aws types
surf aws list-types
```

**List Resources**

Example: List all EKS clusters:

```bash
surf aws list --type eks::cluster
```

**Search existing resources**

```bash
surf aws search -q <query> -t [<resource-type>] -a [<field-key>=<field-val>]
```

Example search: resources containing the `my-app` *anywhere* and are of types `eks` or `vpc`:

```bash
surf aws search -q my-app -t eks -t vpc -a `ClusterName=MyClusterName`
```

Example Describe EKS cluster `my-cluster`:

```bash
surf aws get --type eks::cluster --id my-cluster
```

## AWS ACM Usage

Expand Down
2 changes: 1 addition & 1 deletion cmd/cloudcontrol.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ var cloudcontrolCmdSearch = &cobra.Command{
Use: "search",
Short: "Search existing cloud resources",
Long: `Search Existing AWS resources supported
surf aws search -q 'my-prod' -t vpc -t eks::cluster -a 'ClusterName=lakefs-cloud'
surf aws search -q 'my-prod' -t vpc -t eks::cluster -a 'ClusterName=my-cluster'
`,
Args: cobra.NoArgs,
Run: func(cmd *cobra.Command, args []string) {
Expand Down

0 comments on commit 5d2a2f7

Please sign in to comment.