From 425acc88f7148391ee9188d46656b518c108848b Mon Sep 17 00:00:00 2001 From: dawang Date: Tue, 27 Aug 2024 13:29:11 +0800 Subject: [PATCH] OCM-10672 | Update README --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 53f6149..80c9bb2 100644 --- a/README.md +++ b/README.md @@ -40,13 +40,20 @@ How to delete vpc and the reourses: * NOTE: If the subnets had been existing, it will reuse the exsiting subnets in the zone `$ ocmqe create subnets --region us-west-2 --zones a --vpc-id ` + * Prepare proxy server - * NOTE: Only us-west-2 and ap-northeast-1 persisted the image. - * --ssh-file needs the openshift-qe.pem file path - * --ca-file just need a path to put the generated CA file - - `$ ocmqe create proxy --region us-west-2 --zones a --vpc-id --ssh-file --ca-file ` + * Parameters Description + * --region: Specifies the region where your VPC is located. + * --vpc-id: The id of the VPC under which your MITM proxy will be deployed. + * --zone: Relates to the region and the subnet you have created. It is used to locate an existing public subnet or create a new one if none exists. + * --ca-file: The file path where the MITM proxy’s generated root CA will be stored. Clients will use this root CA to establish secure communication through the MITM proxy. + * --keypair-name: The name of the key pair. Ensure this name does not already exist. + * --privatekey-path: The directory where the SSH credential file will be stored. This file enables users to SSH into the VM where the MITM proxy is installed. + + + `$ ocmqe create proxy --region us-west-2 --vpc-id --zone --ca-file --keypair-name --privatekey-path ` + * Prepare addtional security groups, output the sg IDs with comma seperated @@ -62,4 +69,4 @@ How to delete vpc and the reourses: * Clean the vpc and the resources, there is a flag --total-clean supported to do a total clean even the resources is not created by this package - `$ ocmqe delete vpc --vpc-id --region us-west-2` \ No newline at end of file + `$ ocmqe delete vpc --vpc-id --region us-west-2`