facets-schemas

MongoDB

A MongoDB Instance in clustering mode.

Properties

Property	Type	Required	Description
flavor	string	Yes	Implementation selector for the resource. e.g. for a resource type ingress, default, aws_alb, gcp_alb etc.
kind	string	Yes	Describes the type of resource. e.g. ingress, application, mysql etc. If not specified, fallback is the folder_name/instances
metadata	object	Yes	Metadata related to the resource
spec	object	Yes	Specification as per resource types schema
version	string	Yes	This field can be used to pin to a particular version
advanced	object	No	Additional fields if any for a particular implementation of a resource
depends_on		No	Dependencies on other resources. e.g. application x may depend on mysql
disabled	boolean	No	Flag to disable the resource
lifecycle	string	No	This field describes the phase in which the resource has to be invoked (ENVIRONMENT_BOOTSTRAP) Possible values are: ENVIRONMENT_BOOTSTRAP.
out	object	No	Output given by the resource for others to refer.
provided	boolean	No	Flag to tell if the resource should not be provisioned by facets

spec

Specification as per resource types schema

Property	Type	Required	Description
authenticated	boolean	Yes	Make this mongo is Password protected
mongodb_version	string	Yes	Version of mongo e.g. 5.0.14
persistence_enabled	boolean	Yes	Enable Persistence for this redis
size	object	Yes

size

The size details

Property	Type	Required	Description
replica_count	integer	Yes	Number of mongo instances needs to be deployed [DEPRECATED]
instance_count	integer	Yes	Number of mongo instances needs to be deployed
cpu	string	No	CPU request in format mentioned @ https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
instance	string	No	Instance name in certain cases
memory	string	No	Memory request in format mentioned @ https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
volume	string	No	Volume request in kubernetes persistent volumes

---

advanced

Additional fields if any for a particular implementation of a resource

Property	Type	Required	Description
k8s	object	No	Advanced k8s values for mongo

k8s

Advanced k8s values for mongo

Property	Type	Required	Description
mongo	object	No	Advanced values for mongo

mongo

Advanced values for mongo

Property	Type	Required	Description
values	object	No	Helm values as per the Bitnami mongo chart

out

Output given by the resource for others to refer.

Property	Type	Required	Description
interfaces	object	Yes	mongo broker interface details of type cluster

Added an example of out

{
  "out": {
    "interfaces": {
      "cluster": {
        "connection_string" : "string",
        "endpoint" : "string"
      }
    }
  }
}

interfaces

mongo broker details

Property	Type	Required	Description
connection_string	string	No	Connection string to connect
host	string	No	Host for service discovery
name	string	No	Name of interface, same as key
password	string	No	Password to connect (if any)
port	string	No	Port for service discovery
username	string	No	Username to connect (if any)

cluster

mongo cluster details

Name	Description	Type	Required
endpoint	A comma-separated string of endpoints in the format ‘host1:port1,host2:port2’. The number of endpoints must be greater than or equal to 1.	string	Yes
username	The username to use for authentication when connecting to the datastore.	string	No
password	The password to use for authentication when connecting to the datastore.	string	No
connection_string	The connection_string to use when connecting to the datastore.	string	Yes

Flavors

• k8s