Skip to content

README.md

Latest commit

 

History

History
71 lines (60 loc) · 8.41 KB

README.md

File metadata and controls

71 lines (60 loc) · 8.41 KB
Raw

TODO

Requirements

Name Version
terraform > 0.14, < 2.0.0
aws >= 3.20.0, < 4.0.0
helm >= 2.0
kubernetes >= 2.0.1, < 3.0.0
local >= 2.0

Providers

Name Version
aws >= 3.20.0, < 4.0.0
helm >= 2.0
kubernetes >= 2.0.1, < 3.0.0
local >= 2.0

Modules

Name Source Version
iam_assumable_role_with_oidc_for_log_archival terraform-aws-modules/iam/aws//modules/iam-assumable-role-with-oidc ~> 3.0
s3_iam ./s3_iam n/a

Resources

Name Type
aws_iam_policy.log_archival_access_policy resource
helm_release.rime_agent resource
kubernetes_namespace.auto resource
kubernetes_secret.docker-secrets resource
local_file.terraform_provided_values resource
aws_iam_policy_document.s3_log_archival_access_policy_document data source

Inputs

Name Description Type Default Required
cp_namespace Namespace where the control plane helm chart is installed. Used to determine addresses. string "default" no
cp_release_name Name of the control plane helm release to determine addresses. string "rime" no
create_managed_helm_release Whether to deploy the RIME Agent Helm chart onto the provisioned infrastructure managed by Terraform.
Changing the state of this variable will either install/uninstall the RIME deployment
once the change is applied in Terraform. If you want to install the RIME package manually,
set this to false and use both the custom values file and the terraform generated values YAML file to deploy the release
on the provisioned infrastructure.		 bool false no
custom_values_file_path Optional file path to custom values file for the rime-agent helm release.
Values produced by the terraform module will take precedence over these values.		 string "" no
datadog_tag_pod_annotation Pod annotation for Datadog tagging. Must be a string in valid JSON format, e.g. {"tag": "val"}. string "" no
docker_credentials Credentials to pass into docker image pull secrets. Has creds for all registries. Must be structured like so:
[{
docker-server= "",
docker-username="",
docker-password="",
docker-email=""
}]		 list(map(string)) n/a yes
docker_registry The name of the Docker registry that holds the chart images string "docker.io" no
docker_secret_name The name of the Kubernetes secret used to pull the Docker image for RIME's backend services. string "rimecreds" no
enable_cert_manager enable deployment of cert-manager bool true no
enable_crossplane_tls enable tls for crossplane bool true no
helm_values_output_dir The directory where to write the generated values YAML file used to configure the Helm release.
For the give namespace k8s_namespace, a Helm chart "$helm_values_output_dir/values_$namespace.yaml"
will be created.		 string "" no
log_archival_config The configuration for RIME job log archival. This requires permissions to write to an s3 bucket.
* enable: whether or not to enable log archival.
* bucket_name: the name of the bucket to store logs in.		 
object({
    enable      = bool
    bucket_name = string
  })
 
{
  "bucket_name": "",
  "enable": false
}
 no
manage_namespace Whether or not to manage the namespace we are installing into.
This will create the namespace(if applicable), setup docker credentials as a
kubernetes secret etc. Turn this flag off if you have trouble connecting to
k8s from your terraform environment.		 bool true no
namespace The k8s namespace to install the rime-agent into string n/a yes
oidc_provider_url URL to the OIDC provider for IAM assumable roles used by K8s. string n/a yes
resource_name_suffix A suffix to use with the names of resources created by this module. string n/a yes
rime_docker_agent_image The name of the Docker image for the RIME agent, not including a tag. string "robustintelligencehq/rime-agent" no
rime_docker_default_engine_image The name of the Docker image used as the default for the RIME engine, not including a tag. string "robustintelligencehq/rime-testing-engine-dev" no
rime_repository Repository URL where to locate the requested RIME chart for the give rime_version. string n/a yes
rime_version The version of the RIME software to be installed. string n/a yes
s3_authorized_bucket_path_arns A list of all S3 bucket path arns of which RIME will be granted access to.
Each path must be of the form:
arn:aws:s3:::/sub/path
where is the name of the S3 bucket and sub/path comprises
some path within the bucket. You can also use wildcards '?' or '' within
the arn specification (e.g. 'arn:aws:s3:::datasets/').		 list(string) n/a yes
separate_model_testing_group Whether to force model testing jobs to run on dedicated model-testing nodes, using NodeSelectors bool true no
tags A map of tags to add to all resources. Tags added to launch configuration or templates override these values for ASG Tags only. map(string) {} no

Outputs

No outputs.