Skip to content

Commit

Permalink
more docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ehsandeep committed Aug 17, 2024
1 parent 10a4682 commit 4b90931
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 21 deletions.
44 changes: 28 additions & 16 deletions tools/cloudlist/providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,18 @@ This guide offers insights into each supported provider, enabling you to leverag

### AWS (Amazon Web Services)

Supported AWS Assets:
Supported AWS Services:
- [EC2](https://aws.amazon.com/ec2/)
- [Route53](https://aws.amazon.com/route53/)
- [S3](https://aws.amazon.com/s3/)
- [Cloudfront](https://aws.amazon.com/cloudfront/)
- [ECS](https://aws.amazon.com/ecs/)
- [EKS](https://aws.amazon.com/eks/)
- [ELB](https://aws.amazon.com/elasticloadbalancing/)
- [ELBv2](https://aws.amazon.com/elasticloadbalancing/)
- [Lambda](https://aws.amazon.com/lambda/)
- [Lightsail](https://aws.amazon.com/lightsail/)
- [Apigateway](https://aws.amazon.com/api-gateway/)

**Example Config**:
Amazon Web Services can be integrated by using the following configuration block.
Expand Down Expand Up @@ -48,9 +56,13 @@ References:

### GCP (Google Cloud Platform)

Supported GCP Assets:
- Cloud DNS
- GKE
Supported GCP Services:
- [Cloud DNS](https://cloud.google.com/dns)
- [Kubernetes Engine](https://cloud.google.com/kubernetes-engine)
- [Compute Engine](https://cloud.google.com/products/compute)
- [Bucket](https://cloud.google.com/storage)
- [Cloud Functions](https://cloud.google.com/functions)
- [Cloud Run](https://cloud.google.com/run)

**Example Config:**

Expand All @@ -75,7 +87,7 @@ References:

### Azure

Supported Azure Assets:
Supported Azure Services:
- Virtual Machines

**Example Config:**
Expand Down Expand Up @@ -110,7 +122,7 @@ References:

### Alibaba Cloud

Suppoted Alibaba Cloud Assets:
Suppoted Alibaba Cloud Services:
- ECS Instances

**Example Config:**
Expand Down Expand Up @@ -139,7 +151,7 @@ References:

### DO (DigitalOcean)

Supported DigitalOcean Assets:
Supported DigitalOcean Services:
- Instances

**Example Config:**
Expand All @@ -161,7 +173,7 @@ References:

### SCW (Scaleway)

Supported Scaleway Assets:
Supported Scaleway Services:
- Instances

**Example Config:**
Expand All @@ -183,7 +195,7 @@ References -

### Heroku

Supported Heroku Assets:
Supported Heroku Services:
- Applications

**Example Config:**
Expand Down Expand Up @@ -217,7 +229,7 @@ References:

### Linode

Supported Linode Assets:
Supported Linode Services:
- Instances

**Example Config:**
Expand All @@ -241,7 +253,7 @@ References:

### Fastly

Supported Fastly Assets:
Supported Fastly Services:
- Services

**Example Config:**
Expand All @@ -265,7 +277,7 @@ References -

### Namecheap

Supported Namecheap Assets:
Supported Namecheap Services:
- Domain List

**Example Config:**
Expand Down Expand Up @@ -294,7 +306,7 @@ References:

### Cloudflare

Supported Cloudflare Assets:
Supported Cloudflare Services:
- DNS

**Example Config:**
Expand All @@ -318,7 +330,7 @@ References:

### Hetzner Cloud

Supported Hetzner Cloud Assets:
Supported Hetzner Cloud Services:
- Instances

**Example Config:**
Expand All @@ -340,7 +352,7 @@ References:

### Kubernetes (K8s)

Supported Kubernetes Assets:
Supported Kubernetes Services:
- Services
- Ingresses

Expand Down Expand Up @@ -438,7 +450,7 @@ Terraform can be integrated by using the following configuration block.

### OpenStack

Supported OpenStack Assets:
Supported OpenStack Services:
- Instances

**Example Config:**
Expand Down
17 changes: 12 additions & 5 deletions tools/cloudlist/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Use `cloudlist -h` to display all of the help options.
## Cloudlist options

```yaml
Cloudlist is a tool for listing Assets from multiple cloud providers.

Usage:
./cloudlist [flags]

Expand All @@ -20,11 +22,16 @@ CONFIGURATION:
-pc, -provider-config string provider config file (default "$HOME/.config/cloudlist/provider-config.yaml")

FILTERS:
-p, -provider string[] display results for given providers (comma-separated)
-id string[] display results for given ids (comma-separated)
-host display only hostnames in results
-ip display only ips in results
-ep, -exclude-private exclude private ips in cli output
-p, -provider value display results for given providers (comma-separated) (default linode,fastly,heroku,terraform,digitalocean,consul,cloudflare,hetzner,nomad,do,scw,openstack,alibaba,aws,gcp,namecheap,kubernetes,azure)
-id string[] display results for given ids (comma-separated)
-host display only hostnames in results
-ip display only ips in results
-s, -service value query and display results from given service (comma-separated)) (default cloudfront,gke,domain,compute,ec2,instance,cloud-function,app,eks,consul,droplet,vm,ecs,fastly,alb,s3,lambda,elb,cloud-run,route53,publicip,dns,service,nomad,lightsail,ingress,apigateway)
-ep, -exclude-private exclude private ips in cli output

UPDATE:
-up, -update update cloudlist to latest version
-duc, -disable-update-check disable automatic cloudlist update check

OUTPUT:
-o, -output string output file to write results
Expand Down

0 comments on commit 4b90931

Please sign in to comment.