Skip to content

Commit

Permalink
Merge pull request #16 from 86254860/topic/dawang/up-readme-10672
Browse files Browse the repository at this point in the history
OCM-10672 | Update README
  • Loading branch information
xueli181114 authored Aug 27, 2024
2 parents 5f472d6 + 425acc8 commit a7689f5
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 <vpc id> --ssh-file <openshift-qe.pem file path> --ca-file <ca-file path>`
* 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 <vpc id> --zone <e.g. us-west-2a> --ca-file <ca file path, eg. ~/proxy/ca-file.pem> --keypair-name <keypair name> --privatekey-path <the directory which store privatekey, e.g. ~/proxy/>`


* Prepare addtional security groups, output the sg IDs with comma seperated

Expand All @@ -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 <vpc id> --region us-west-2`
`$ ocmqe delete vpc --vpc-id <vpc id> --region us-west-2`

0 comments on commit a7689f5

Please sign in to comment.