Merge pull request #37 from one2nc/update-documentation

Update cloudlens documentation to have gcp resources

README.md

@@ -2,11 +2,11 @@
       <img src="assets/cloudlens.png" alt="Cloudlens" width="225" height="150" >
 </p>
 
-## Cloudlens - k9s like CLI for AWS. 
+## Cloudlens - k9s like CLI for AWS and GCP. 
 
 ![](./assets/cloudlensdemo.gif)
 
-AWS Console in your terminal! well, almost. Explore AWS services like EC2, S3, IAM, VPC, etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens.
+AWS and GCP Console in your terminal! well, almost. Explore AWS and GCP services like EC2, S3, IAM, VPC, VM, Storage  etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens.
 
 ## Installation
 
@@ -38,12 +38,24 @@ AWS Console in your terminal! well, almost. Explore AWS services like EC2, S3, I
 
 ## Usage
 
-For the simple usage, just run the command without any options.
+### Using UI
+- For the simple usage, just run the `cloudlens` command without any options.
+- This will open an UI to select cloud platform.
+- Note: when selecting `GCP` as cloud, make sure to set `GOOGLE_APPLICATION_CREDENTIALS` env variable to gcp-credentials file's path.
 
 ```shell
 cloudlens
 ```
-
+### Using Sub-Commands
+- Alternative to UI, you could also use sub-commands and flags to select cloud platform.
+- To select AWS.
+```shell
+cloudlens aws
+```
+- To select GCP.
+```shell
+cloudlens gcp --cf="path/to/gcp-credentials.json"
+```
 For knowing all the options available, use:
 ```shell
 cloudlens help
@@ -65,10 +77,15 @@ cloudlens aws --localstack --port 4000
 
 ## Features
 
-Cloudlens supports viewing EC2 instances, S3 buckets, EBS volumes, VPCs, SQS queues, Lambda functions, Subnets, Security Groups, and IAM roles. Read the [cloudlens documentation](https://one2n.gitbook.io/docs/) to know more.
+### AWS
+For AWS Cloudlens supports viewing EC2 instances, S3 buckets, EBS volumes, VPCs, SQS queues, Lambda functions, Subnets, Security Groups, and IAM roles. 
+### GCP
+For GCP Cloudlens supports viewing VM instances, Storage buckets, Disks, Snapshots, Images.
 
-## Screenshots
+ Read the [cloudlens documentation](https://one2n.gitbook.io/docs/) to know more.
 
+## Screenshots
+### AWS
 1. EC2
       <img src="assets/ec2.png"/>
 1. EC2 Details
@@ -78,6 +95,16 @@ Cloudlens supports viewing EC2 instances, S3 buckets, EBS volumes, VPCs, SQS que
       <img src="assets/s3.png"/>
 2. S3 Details
       <img src="assets/s3Details.png"/>
+### GCP
+1. VM
+      <img src="assets/gcp_vm.png"/>
+1. VM Details
+      <img src="assets/gcp_vm_details.png"/>
+
+2. Storage
+      <img src="assets/gcp_storage.png"/>
+2. Storage Details
+      <img src="assets/gcp_storage_details.png"/>
 
 ## Documentation
 
@@ -94,6 +121,7 @@ Cloudlens uses k9s like shortcuts for navigation. Listed below are few of the sh
 | To bail out of cloudlens                  | :q ,   ctrl-c |
 | Bails out of view/command/filter mode     | esc         |
 | To view and switch to another AWS Service | :S3/EC2/VPC⏎  |
+| To view and switch to another GCP Service | :storage/vm/disk⏎  |
 
 ## Note
 **Cloudlens reads your ~/.aws/config file, but it does not store or send your access and secret key anywhere. The access and secret key is used only to securely connect to AWS API via AWS SDK.**

docs/README.md

@@ -1,5 +1,5 @@
 ---
-description: k9s like CLI for AWS
+description: k9s like CLI for AWS and GCP
 ---
 
 # 👋 Cloudlens
@@ -8,7 +8,7 @@ description: k9s like CLI for AWS
 
 ## Terminal-ate Your Cloud Worries!
 
-AWS Console in your terminal! well, almost. Explore AWS services like EC2, S3, IAM, VPC, etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens.
+AWS and GCP Console in your terminal! well, almost. Explore AWS and GCP services like EC2, S3, IAM, VPC, VM, Storage  etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens.
 
 ### Got 2 minutes? Check out a video overview of cloudlens:
 
@@ -36,7 +36,7 @@ cloudlens
 
 </details>
 
-### Features
+### AWS Features
 
 | Services                            | Description                                                           | Alias   |
 | ----------------------------------- | --------------------------------------------------------------------- | ------- |
@@ -54,6 +54,16 @@ cloudlens
 | [SQS](./#sqs)                       | view a list of all SQS queues                                         | `sqs`   |
 | [Lambda](./#lambda)                 | view a list of all Lambda functions                                   | `lamda` |
 
+### GCP Features
+
+| Services                            | Description                                                           | Alias   |
+| ----------------------------------- | --------------------------------------------------------------------- | ------- |
+| [Storage](./#storage)                         | View all storage buckets and their contents                                | `storage`    |
+| [VM](./#vm)                       | view all instances and their associated metadata, including JSON data | `vm`   |
+| [VM Snapshot](./#vm-snapshot)     | view a list of all VM snapshots                                      | `vm:S` |
+| [VM Image](./#vm-image)           | See a list of all VM images                                          | `vm:I` |
+| [Disk](./#disk)                       | View all available disks                                         | `disk`   |
+
 ### Prompt
 
 To view the input prompt, press the  :  key. From there, you can try different commands to access and view various services.You can use the tab key or the right arrow key for autocomplete to make entering commands faster and easier.
@@ -78,6 +88,8 @@ You can switch between the dropdown options using the tab button.
 
 <figure><img src=".gitbook/assets/image (28).png" alt="Dropdowns"><figcaption><p>Dropdowns</p></figcaption></figure>
 
+## AWS Resources
+
 ### S3
 
 To view the <mark style="color:orange;">S3</mark> page, use the command `s3` in your prompt. Pressing enter will display all the available buckets, folders, and files. You can use the escape key to go back to the previous page.. Additionally, you can download a CSV file using the `z` command.
@@ -175,3 +187,45 @@ To view <mark style="color:orange;">SQS queues</mark>, enter `sqs` in the comman
 View all your Lambda functions easily by entering 'lambda' command in your terminal prompt.
 
 <figure><img src=".gitbook/assets/image (12).png" alt=""><figcaption></figcaption></figure>
+
+## GCP Resources
+
+### Storage
+
+To view the <mark style="color:orange;">Storage buckets</mark> page, use the command `storage` in your prompt. Pressing enter will display all the available buckets, folders, and files. You can use the escape key to go back to the previous page.. Additionally, you can download a CSV file using the `z` command.
+
+<figure><img src=".gitbook/assets/gcp_storage.png" alt="S3 Page"><figcaption><p>Storage Page</p></figcaption></figure>
+
+<figure><img src=".gitbook/assets/gcp_storage_details.png" alt="Storage Details Page"><figcaption><p>Storage Details Page</p></figcaption></figure>
+
+### VM
+
+To view the <mark style="color:purple;">VM</mark> page, enter the command `vm` in your prompt. Pressing enter will display all available instances. To view specific details about an instance, select it and press enter to display a JSON with the VM information. You can use the escape key to navigate back to the previous page. Additionally, you can download a CSV file by using the `z` command.
+
+<figure><img src=".gitbook/assets/gcp_vm.png" alt="VM Page"><figcaption><p>VM Page</p></figcaption></figure>
+
+<figure><img src=".gitbook/assets/gcp_vm_details.png" alt="VM Details Page"><figcaption><p>VM Details Page</p></figcaption></figure>
+
+### VM Snapshot
+
+To access the <mark style="color:blue;">VM snapshots</mark> page, enter `vm:S` in your prompt and press Enter. This will display a list of all available snapshots. Select a snapshot to view its details, then press Enter again. To return to the previous page, press the Escape key.
+
+<figure><img src=".gitbook/assets/gcp_vm_snapshots.png" alt="VM Snapshot Page"><figcaption><p>VM Snapshot Page</p></figcaption></figure>
+
+<figure><img src=".gitbook/assets/gcp_snapshot_details.png" alt="VM Snapshot Details Page"><figcaption><p>VM Snapshot Details Page</p></figcaption></figure>
+
+### VM Image
+
+To access the <mark style="color:blue;">VM image</mark> page, enter `vm:I` in your prompt and press Enter. This will display a list of all available images. Select an image to view its details, then press Enter again. To return to the previous page, press the Escape key.
+
+<figure><img src=".gitbook/assets/gcp_vm_images.png" alt="VM Image Page"><figcaption><p>VM Image Page</p></figcaption></figure>
+
+<figure><img src=".gitbook/assets/gcp_image_details.png" alt="VM Image Details Page"><figcaption><p>VM Image Details Page</p></figcaption></figure>
+
+### Disk
+
+To view <mark style="color:green;">Disks</mark>, enter `disk` in the command prompt and press Enter to show a list of disks. Select a disk and press Enter to view its details. To return to the previous page, press the Escape key.
+
+<figure><img src=".gitbook/assets/gcp_disks.png" alt="Disk Page"><figcaption><p>Disk Page</p></figcaption></figure>
+
+<figure><img src=".gitbook/assets/gcp_disks_details.png" alt="Disk Details Page"><figcaption><p>Disk Details Page</p></figcaption></figure>