solr-on-ecs.yml

version: 1
name: solr-on-ecs
id: 182612a5-e2b7-4afc-b2b2-9f9d066875d1
description: Independent indexing and searching using Apache Solr
display_name: Solr on ECS
image_url: https://lucene.apache.org/theme/images/solr/identity/Solr_Logo_on_white.png
documentation_url: https://lucene.apache.org/solr/resources.html
support_url: https://github.com/GSA/datagov-brokerpak-solr
tags: [apache, search, index, k8s]

plans:
- name: base
  id: 4d7f0501-77d6-4d21-a37a-8b80a0ea9c0d
  description: Provision a standalone leader/follower Solr deployment for use by applications
  display_name: Provision and use standalone Solr in your app
  bullets:
  - "REQUIRED prerequisite: An AWS Account into which Solr resources with be launched."
  properties: {}
provision:
  plan_inputs: []
  user_inputs:
  - field_name: solrImageRepo
    required: false
    type: string
    details: "Repo for the Solr Docker image to use, defaults to docker.io/solr"
  - field_name: solrImageTag
    required: false
    type: string
    details: "Tag for the Solr Docker image to use, defaults to 8.11. See https://hub.docker.com/_/solr?tab=tags (or your configured solrImageRepo) for options"
  - field_name: solrMem
    required: false
    type: number
    details: "How much memory to request for each replica (default is '6G')"
  - field_name: solrCpu
    required: false
    type: number
    details: "How much vCPU to request for each replica (default is '2000m' aka '2 vCPUs')"
  - field_name: setupLink
    required: false
    type: string
    details: "The Solr setup file for initialization of cores/authentication/et cetera..."
  - field_name: efsProvisionedThroughput
    required: false
    type: number
    details: "The throughput, measured in MiB/s, that you want to provision for the file system"
  - field_name: efsProvisionedThroughputFollower
    required: false
    type: number
    details: "The throughput, measured in MiB/s, that you want to provision for the file system of the followers"
  - field_name: efsPerformanceMode
    required: false
    type: string
    details: "The file system performance mode. Can be either \"generalPurpose\" or \"maxIO\" (Default: \"generalPurpose\")"
  - field_name: disableEfs
    required: false
    type: boolean
    details: "Launch Solr with local storage"
  - field_name: disableEfsFollower
    required: false
    type: boolean
    details: "Launch Solr Followers with local storage"
  - field_name: solrFollowerCount
    required: false
    type: number
    details: "How many Solr Followers should be created"
  - field_name: solrFollowerCpu
    required: false
    type: number
    details: "How much vCPU to request for each follower replica (default is '2048' aka '2 vCPUs')"
  - field_name: solrFollowerMem
    required: false
    type: number
    details: "How much memory to request for each follower replica (default is '12G')"
  - field_name: solrFollowerDiskSize
    required: false
    type: number
    details: "How much ephemeral storage disk space Solr Followers will have"
  - field_name: setupFollowerLink
    required: false
    type: string
    details: "The Solr setup file for follower to initialize cores/authentication/et cetera..."
  - field_name: slackNotification
    required: false
    type: boolean
    details: "Enable slack notifications for Solr Errors/restarts via webhook integration"
  - field_name: emailNotification
    required: false
    type: string
    details: "Enable email notifications for Solr Errors/restarts"
  computed_inputs:
  - name: instance_name
    type: string
    details: "The name of the cloud to create (used only for demo purposes)"
    overwrite: true
    default: ${request.instance_id}
  - name: labels
    default: ${json.marshal(request.default_labels)}
    overwrite: true
    type: object
    details: "Labels with the org, space, and instance ID"
  - name: solrImageRepo
    default: "ghcr.io/gsa/catalog.data.gov.solr"
    overwrite: false
    type: string
  - name: solrImageTag
    default: "8-stunnel-root"
    overwrite: false
    type: string
  - name: solrMem
    default: 14336
    overwrite: false
    type: number
  - name: solrCpu
    default: 4096
    overwrite: false
    type: number
  - name: setupLink
    default: "https://raw.githubusercontent.com/GSA/catalog.data.gov/main/solr/solr_setup.sh"
    overwrite: false
    type: string
  - name: efsProvisionedThroughput
    default: 1
    overwrite: false
    type: number
  - name: efsProvisionedThroughputFollower
    default: 1
    overwrite: false
    type: number
  - name: efsPerformanceMode
    default: "generalPurpose"
    overwrite: false
    type: string
  - name: disableEfs
    default: false
    overwrite: false
    type: boolean
  - name: disableEfsFollower
    default: false
    overwrite: false
    type: boolean
  - name: solrFollowerMem
    default: 14336
    overwrite: false
    type: number
  - name: solrFollowerCpu
    default: 4096
    overwrite: false
    type: number
  - name: solrFollowerCount
    default: 0
    overwrite: false
    type: number
  - name: solrFollowerDiskSize
    default: 50
    overwrite: false
    type: number
  - name: setupFollowerLink
    default: "https://raw.githubusercontent.com/GSA/catalog.data.gov/main/solr/solr_setup.sh"
    overwrite: false
    type: string
  - name: slackNotification
    default: false
    overwrite: false
    type: boolean
  - name: emailNotification
    default: ""
    overwrite: false
    type: string
  - name: region
    type: string
    details: "The AWS region in which to create all AWS resources"
    overwrite: true
    default: ${config("aws.default_region")}
  - name: zone
    type: string
    details: "The Route53 zone in which to create k8s instances"
    overwrite: true
    default: ${config("aws.zone")}
  outputs:
  - field_name: solr_leader_url
    details: "The Solr Leader url for the created instance"
    type: string
    required: true
  - field_name: solr_follower_url
    details: "The Solr Follower url for the created instance (routes to all follower instances randomly)"
    type: string
    required: true
  - field_name: solr_follower_individual_urls
    details: "The Solr Follower urls for each follower instance"
    type: string
    required: true
  - field_name: solr_admin_user
    details: "The admin username for access to the Solr Instance"
    type: string
    required: true
  - field_name: solr_admin_pass
    details: "The admin password for access to the Solr Instance"
    type: string
    required: true
  template_refs:
    admin: terraform/ecs/provision/admin.tf
    app-template: terraform/ecs/provision/app_template.tf
    cloudwatch: terraform/ecs/provision/cloudwatch.tf
    dns: terraform/ecs/provision/dns.tf
    private-dns: terraform/ecs/provision/private-dns.tf
    leader: terraform/ecs/provision/leader.tf
    efs: terraform/ecs/provision/efs-leader.tf
    iam: terraform/ecs/provision/iam.tf
    lb: terraform/ecs/provision/lb-leader.tf
    logging: terraform/ecs/provision/logging.tf
    restarts: terraform/ecs/provision/restarts.tf
    ssl: terraform/ecs/provision/ssl.tf
    vpc: terraform/ecs/provision/vpc.tf
    outputs: terraform/ecs/provision/outputs.tf
    variables: terraform/ecs/provision/variables.tf
    versions: terraform/ecs/provision/versions.tf

    # Separate configuration for solr followers
    follower: terraform/ecs/provision/follower.tf
    lb-follower: terraform/ecs/provision/lb-follower.tf
    efs-follower: terraform/ecs/provision/efs-follower.tf
bind:
  plan_inputs: []
  user_inputs: []
  computed_inputs:
  - name: instance_name
    default: ${request.instance_id}
    overwrite: true
    type: string
  - name: solr_admin_pass
    default: ${instance.details["solr_admin_pass"]}
    overwrite: true
    type: string
  - name: solr_admin_user
    default: ${instance.details["solr_admin_user"]}
    overwrite: true
    type: string
  - name: solr_leader_url
    default: ${instance.details["solr_leader_url"]}
    overwrite: true
    type: string
  - name: solr_follower_url
    default: ${instance.details["solr_follower_url"]}
    overwrite: true
    type: string
  - name: solr_follower_individual_urls
    default: ${instance.details["solr_follower_individual_urls"]}
    overwrite: true
    type: string
  outputs:
  - field_name: domain
    required: false
    type: string
    details: The domain of the Solr Leader instance that was created
  - field_name: domain_replica
    required: false
    type: string
    details: The domain of the Solr Follower instances that were created
  - field_name: username
    required: false
    type: string
    details: The username of the Solr instances (leader + followers) that were created
  - field_name: password
    required: false
    type: string
    details: The password of the Solr instances (leader + followers) that were created
  - field_name: uri
    required: true
    type: string
    details: The URL to use for working with the Solr Leader instance
  - field_name: solr_leader_url
    details: "The Solr Leader url for the created instance"
    type: string
    required: true
  - field_name: solr_follower_url
    details: "The Solr Follower url for the created instance (routes to all follower instances randomly)"
    type: string
    required: true
  - field_name: solr_follower_individual_urls
    details: "The Solr Follower urls for each follower instance"
    type: string
    required: true
  - field_name: solr_admin_user
    details: "The admin username for access to the Solr instances (leader + followers)"
    type: string
    required: false
  - field_name: solr_admin_pass
    details: "The admin password for access to the Solr instances (leader + followers)"
    type: string
    required: false
  template_refs:
    main: terraform/ecs/bind/main.tf
    outputs: terraform/ecs/bind/outputs.tf
    variables: terraform/ecs/bind/variables.tf
    versions: terraform/ecs/bind/versions.tf

examples: []
plan_updateable: false
requiredenvvars: []