suneshgovind / metadefender-k8s Goto Github PK

OPSWAT MetaDefender products are adapting year over year for our customers to get advantage of the new technologies that are coming. With this project you will be able to deploy some of our MetaDefender products to a Kubernetes Cluster. We provide you with some architecture recommendations for the main cloud providers to host the Kubernetes cluster together with an script to provision such recommended architecture. Also we provide you with all the information of the components that will be installed inside the cluster to run our products and a script to install it depending on the different configuration options.

Main Metadefender documentation pages:

• AWS Cloud Deployment Architectures Recommended Doc
• MetaDefender Core Provisioned in AWS EKS Doc
• MetaDefender Core Kubernetes Components Doc
• MetaDefender Core In Your Already Created Kubernetes Cluster Doc
• MetaDefender for Secure Storage Kubernetes deployment Doc

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

• In case of provisioning with the MetaDefender scipt the resources recommended from OPSWAT
  • Knowledge of choosen CSP: OPSWAT assume familiarity with AWS or Azure in case you provision the infrastructure with the MetaDefender Script
  • Account of the choosen CSP to create all the resources needed
• Scripting languages supported: Linux - shell
• Pre-requisites:
  • Terraform
  • Helm
  • AWS-CLI
  • Kubectl

OPSWAT has prepared a recommended architecture for having Metadefender products deployed in a Kubernetes Cluster in the main CSP. Depending on the architecture prefered the installation process is different as each product has its own configuration options. To facilitate the deployment of the product we have created what we call MetaDefender K8S script that will guide you through the different options and configure the enviroment for you.

There are two modes for using the script provision and install.

For provision in AWS follow this doc For install MD Core in an already created cluster follow this doc

Sep 28, 2023

New

• Configure AWS Load Balancer Controller from metadefenderk8s script
• Configure GCP SQL Proxy from metadefenderk8s script
• Configure Region for all the CSPs from metedefenderk8s script
• Configure LBs to have attached a Private or Public IP from metedefenderk8s script

Fixed

• Minor issues fixed in MetaDefender K8S script
• Set default terraform.tfvars for Azure provision
• EKS cluster not being able to AddTags for creating AWS Load Balancer

Sep 14, 2023

New

• Removed activation manager sidecar container as it is not needed anymore, application container handle the activation/deactivation
• Health check set up from environment variables
• Proxy configuration from environment variables

Fixed

• Minor fixed in MetaDefender K8S script
• Broken links in readme file

Sep 6, 2023

New

• Resource requests and limits for each pod of MetaDefender for Secure Storage
• Readiness Probe using health check for MetaDefender Core

Fixed

• Azure PostgreSQL set up when using MetaDefender K8S script
• Deployment template when enabling TLS of MetaDefender Core

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/newGreatEnhancement)
3. Commit your Changes (git commit -m 'Add some new great enhancement')
4. Push to the Branch (git push origin feature/newGreatEnhancement)
5. Open a Pull Request

(back to top)

For running MetaDefender products you will need to set up the license needed for each of the products, in case of not having such license key please contact Sales: [email protected].

In case of having any issue with your license please contact Support

For other questions

(back to top)

OPSWAT Contact Information

• Sales: [email protected]
• Support: https://www.opswat.com/support
• Contact US: https://www.opswat.com/contact

MetaDefender Core Documentation: https://docs.opswat.com/mdcore MetaDefender for Secure Storage Documentation: https://docs.opswat.com/mdss

(back to top)