Skip to content

Commit

Permalink
add deployment details
Browse files Browse the repository at this point in the history
  • Loading branch information
Mohammad Zuber Khan committed Sep 14, 2020
1 parent 94d24da commit 1e9360f
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions remediation_worker/jobs/azure_vm_close_port_22/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Close Port 22 for a VM

This job blocks public access to port 22 for the VM
This job blocks public access to port 22 for the VM.
This job remediates the violation caused because of the following rule.

####Rule Name:
A virtual machine is publicly accessible to the internet via port 22

####Rule ID:
d7a3ad03-860c-4928-9ba8-789e84a835be

## Getting Started

Expand All @@ -25,8 +32,23 @@ You may run test using following command under vss-remediation-worker-job-code-p
python3 -m pytest test
```

## Deployment
1. Provision a Virtual Machine
Create an EC2 instance to use for the worker. The minimum required specifications are 128 MB memory and 1/2 Core CPU.
2. Setup Docker
Install Docker on the newly provisioned EC2 instance. You can refer to the [docs here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/docker-basics.html) for more information.
3. Deploy the worker image
SSH into the EC2 instance and run the command below to deploy the worker image:
```shell script
docker run --rm -it --name worker \
-e VSS_CLIENT_ID={ENTER CLIENT ID}
-e VSS_CLIENT_SECRET={ENTER CLIENT SECRET} \
vmware/vss-remediation-worker:latest-python
```


## Contributing
The Secure State team welcomes welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
The Secure State team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

For more detailed information, refer to [CONTRIBUTING.md](../../../CONTRIBUTING.md).
Expand All @@ -43,4 +65,4 @@ See also the list of [contributors](https://github.com/your/project/contributors

## License

This project is licensed under the Apache License - see the [LICENSE](https://github.com/vmware-samples/secure-state-remediation-jobs/blob/master/LICENSE.txt) file for details
This project is licensed under the Apache License - see the [LICENSE](https://github.com/vmware-samples/secure-state-remediation-jobs/blob/master/LICENSE.txt) file for details

0 comments on commit 1e9360f

Please sign in to comment.