Using your existing Kubernetes (K8S) cluster
This guide explains how to use the provisioning script to generate all the K8S components needed to run MetaDefender ICAP Server in your-already-created K8S cluster.
That requires some configuration options to be chosen, and the helm chart values to be configured properly.
Customized Installation
As for the demand of customizing the installation of our MetaDefender ICAP Server product in a K8S cluster, we have published the helm chart on GitHub: https://github.com/OPSWAT/metadefender-k8s/tree/main/helm_charts/icap
How to Install MetaDefender ICAP Server using Helm
This chart can deploy the following depending on your chosen configuration options:
- One or more MD ICAP Server instances
git clone https://github.com/OPSWAT/metadefender-k8s.gitcd metadefender/helm_carts/icaphelm install md-icapsrv ./icap . #You can replace the file for specific scenarioRemarkable Configuration Options
The following table explains the different values that are remarkable to be set when customizing the installation. All these values will be set for you if you decide to use the MetaDefender K8S script explained in the above sections.
| Parameter | Description | Default |
|---|---|---|
| persistance_enabled | Set to false to not create any volumes or host paths in the deployment, all storages will be ephemeral. | true |
| icap_docker_repo | Docker repo to use, this should be changed when using private images (this string will be prepended to the image name). | opswat |
| mdicapsrv_password | Initial admin password for the MetaDefender ICAP Server web interface, if not set it will be randomly generated. | null |
| mdicapsrv_api_key | 36 character API key used for the MetaDefender ICAP Server REST API, if not set it will be randomly generated. | null |
| mdicapsrv_license_ key | A valid license key, this value is mandatory. | null |
| environment | Deployment environment type, the default generic value will not configure or provision any additional resources in the cloud provider (like load balancers), other values: aws_eks_fargate. | generic |
| app_name | Application name, it also sets the namespace on all created resources and replaces <APP_NAME> in the ingress host (if the ingress is enabled). | default |
| mdicapsrv_user | Initial admin user for the MetaDefender ICAP Server web interface. | admin |
| icap_components.md_icapsrv.image | Overrides the default docker image for the MetaDefender ICAP Server service, this value can be changed if you want to set a different version of MetaDefender ICAP Server | <SET_DOCKER_IMAGE_HERE> |
| icap_components.md_icapsrv.replicas | Sets the number of replicas if you want to have multiple MetaDefender ICAP Server instances | 1 |