Powered by AlgoliaSee more results
    DocsAPIBack to Spectro Cloud

    Helm Chart Install Reference

    You can use the Palette Helm Chart to install Palette in a multi-node Kubernetes cluster in your production environment. The Helm chart allows you to customize values in the values.yaml file. This reference lists and describes parameters available in the values.yaml file from the Helm Chart for your installation. To learn how to install Palette using the Helm Chart, refer to Helm Chart Mode.

    Required Parameters

    The following parameters in the values.yaml file are required:

    • env.rootDomain - Used to configure the domain for the Palette installation. You should create a CNAME DNS record separately, and it should be a wildcard to account for Organization prefixes. Review the Environment parameters to learn more.

    • natsUrl - The URL format specifies how to configure NATS servers to the IP address and port. Review the Network Address Translation (NATS) parameters to learn more.

    • Registry and Palette Artifact Repository - Specifies the Docker registry where chart images are stored and the Palette Artifact Repository (PAR). Refer to the Registry and Palette Artifact Repository parameters.

    MongoDB

    Palette uses MongoDB as its database and supports two modes of deployment:

    • MongoDB deployed and active inside the cluster.
    • MongoDB hosted on a software as a service (SaaS) platform, such as Atlas.

    The table lists the parameters used to configure a MongoDB deployment.

    ParametersDefault valueTypeDescriptionRequired/Optional
    internaln/aBooleanSpecifies the MongoDB deployment either in-cluster or using Mongo Atlas.Required
    databaseUrlmongo-0.mongo,mongo-1.mongo,mongo-2.mongoStringURL for MongoDB. Change the URL if you are using Mongo Atlas.Required
    databasePassword""StringThe base64 encoded MongoDB password.Optional
    replicas3IntegerSpecifies the number of MongoDB replicas to start.Required
    cpuLimit2000mStringSpecifies the CPU limit for each MongoDB replica.Optional
    memorylimit4GiStringSpecifies the memory limit for each MongoDB replica.Optional
    pvcSize20GiStringSpecifies the Persistent Volume Claim (PVC) size for each MongoDB replica.Optional
    storageClass""StringStorage class for the PVC. Leave this empty to use the default storage class.Optional
    mongo:
      databaseUrl: "mongo-0.mongo,mongo-1.mongo,mongo-2.mongo"
      replicas: 3
      cpuLimit: "2000m"
      memoryLimit: "4Gi"
      pvcSize: "20Gi"
      storageClass: ""

    Config

    The configuration file contains the following sections.

    SSO

    The table lists parameters to configure SSO SAML authentication in Palette.

    ParametersDefault valueTypeDescriptionRequired/Optional
    saml.enabledfalseBooleanSpecifies whether to enable SSO SAML configuration by setting it to true.Optional
    saml.acsUrlRootmyfirstpalette.spectrocloud.comStringRoot URL of the Assertion Consumer Service (ACS).Optional
    saml.acsUrlSchemehttpsStringURL scheme of the ACS either http or https.Optional
    saml.audienceUrlhttps://www.spectrocloud.comStringURL of the intended audience for the SAML response.Optional
    saml.entityIDhttps://www.spectrocloud.comStringEntity ID of the Service Provider.Optional
    saml.apiVersionv1StringSSO SAML API version to use.Optional
    config:
      sso:
        saml:
          enabled: false
          acsUrlRoot: "myfirstpalette.spectrocloud.com"
          acsUrlScheme: "https"
          audienceUrl: "https://www.spectrocloud.com"
          entityId: "https://www.spectrocloud.com"
          apiVersion: "v1"

    Email

    The table lists the parameters to configure email settings in Palette's self-hosted mode.

    ParametersDefault valueTypeDescriptionRequired/Optional
    enabledfalseBooleanSpecifies whether to enable email configuration.Optional
    emailID ""StringEmail address for sending mail.Optional
    smtpServersmtp.gmail.comStringSimple Mail Transfer Protocol (SMTP) server used for sending mail.Optional
    smtpPort587IntegerSMTP port used for sending mail.Optional
    insecureSkipVerifyTIstrueBooleanSpecifies whether to skip Transport Layer Security (TLS) verification for the SMTP connection.Optional
    fromEmailIDnoreply@spectrocloud.comStringEmail address of the From address.Optional
    password""StringThe base64-encoded SMTP password when sending emails.Optional
    config:
      email:
        enabled: false
        emailId: "<username>@spectrocloud.com"
        smtpServer: "smtp.gmail.com"
        smtpPort: 587
        insecureSkipVerifyTls: true
        fromEmailId: "noreply@spectrocloud.com"
        password: ""

    Environment

    The table lists environment variables required to deploy Palette.

    ParametersDefault valueTypeDescriptionRequired/Optional
    env.rootDomain""StringSpecifies the default Domain Name System (DNS) record mapped to the ingress-nginx-controller load balancer. It is required if false. Otherwise, leave it empty.Required
    env.installerModeself-hostedStringSpecifies the installer mode. Do not modify the value.Required
    env.installerCloud""StringSpecifies the cloud provider. It should be left empty.Optional
    config:
        env:
        rootDomain: ""
        installerMode: "self-hosted"
        installerCloud: ""

    Cluster

    The cluster parameter specifies how the Kubernetes cluster is deployed.

    ParametersDefault valueTypeDescriptionRequired/Optional
    stableEndpointAccessfalseBooleanFalse indicates the Kubernetes cluster is deployed in a private network through a stable private endpoint. True indicates the cluster is deployed through a public endpoint.Optional
    config:
        cluster:
        stableEndpointAccess: false

    Registry and Palette Artifact Repository (PAR)

    The table lists Registry and Palette Artifact Repository (PAR) parameters to install Palette using Helm Chart.

    ParametersDefault valueTypeDescriptionRequired/Optional
    registry.endpoint""StringThe endpoint URL for the registry.Required
    registry.name""StringThe name of the registry.Required
    registry.password""StringThe password for the registry.Required
    registry.username""StringThe username for the registry.Required
    scar.endpoint""StringThe endpoint URL of the PAR.Required
    scar.username""StringThe username for the PAR.Required
    scar.password""StringThe password for the PAR.Required
    config:
        registry:
        endpoint: "<Contact Spectro Cloud Sales for More info>"
        name: "<Contact Spectro Cloud Sales for More info>"
        password: "<Contact Spectro Cloud Sales for More info>"
        username: "<Contact Spectro Cloud Sales for More info>"
    

        scar:
        endpoint: "<Contact Spectro Cloud Sales for More info>"
        username: "<Contact Spectro Cloud Sales for More info>"
        password: "<Contact Spectro Cloud Sales for More info>"

    Contact support@spectrocloud.com to gain access to the Helm Chart.

    Network Address Translation (NATS)

    The table lists Network Address Translation (NATS) parameters that Palette uses for communication between the tenant and management clusters. The internal flag determines whether NATS uses a new load balancer or the existing ingress service. To learn about NATS cluster configuration map properties, refer to NATS clustering configuration.

    Parameters Default ValueType DescriptionRequired/Optional
    internaltrueBooleantrue means NATS shares the ingress load balancer or uses hostNetwork. false means a cloud load balancer is used.Optional
    natsUrl""StringComma-separated list of <dns_name:port> mappings for NATS load balancer service. Required if nats.internal is false.Required
    annotations{}MapA map of key-value pairs that specify the load balancer annotations for NATS. These annotations vary depending on the cloud provider.Optional
    routes[]ListList of server URLs for clustering (excluding self-routes) that can include authentication via token or username/password in the URL.Optional
    natsStaticIP""StringStatic IP for the NATS load balancer service. If empty, a dynamic IP address will be generated.Optional
    nats:
      internal: true
      natsUrl: ""
      annotations: {}
      routes: []
      natsStaticIP: ""

    Ingress

    The table lists parameters used to configure the NGINX Ingress Controller, which provides an external HTTP load balancer for Kubernetes services. Refer to Set Up Ingress for more guidance.

    ParametersDefault ValueTypeDescriptionRequired/Optional
    InternalfalseBooleanSpecify whether to use a cloud load balancer or host network.Required
    certificate""StringDefault SSL certificate for NGINX Ingress Controller. If left blank, the NGINX Ingress Controller will generate a self-signed certificate.Optional
    key""StringDefault SSL key for the NGINX Ingress Controller.Optional
    annotations{}MapA map of key-value pairs that specifies load balancer annotations for ingress.Optional
    ingressStaticIP""StringStatic IP for the ingress load balancer service. If empty, a dynamic IP address will be generated.Optional
    terminateHTTPSAtLoadBalancerfalseBooleanSpecify whether to terminate HTTPS at the load balancer.Optional
    ingress:
      ingress:
        internal: false
        certificate: ""
        key: ""
        annotations: {}
        ingressStaticIP: ""
        terminateHTTPSAtLoadBalancer: false

    Spectro Proxy

    The table lists parameters to configure the Spectro server-side proxy.

    ParametersDefault ValueTypeDescriptionRequired/Optional
    enabledfalseBooleanSpecifies whether Spectro Proxy is enabled or not.Optional
    frpHostURLproxy.sample.spectrocloud.comStringThe URL of the Spectro proxy host.Optional
    server.crt"LS0..."StringSpecifies the certificate file for the Spectro Proxy server.Optional
    server.key"LS0..."StringSpecifies the private key file for the Spectro Proxy server.Optional
    ca"LS0..."StringSpecifies the Certificate Authority (CA) for the Spectro Proxy server.Optional
    ca.crt"LS0..."StringSpecifies the CA certificate file for the Spectro Proxy server.Optional
    frps:
      frps:
        enabled: false
        frpHostURL: proxy.sample.spectrocloud.com
        server:
          crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURqekNDQW5lZ0F3SUJBZ0lVZTVMdXBBZGljd0Z1SFJpWWMyWEgzNTFEUzJJd0RRWUpLb1pJaHZjTkFRRUwKQlFBd0tERW1NQ1FHQTFVRUF3d2RjSEp2ZUhrdWMyRnRjR3hsTG5Od1pXTjBjbTlqYkc5MVpDNWpiMjB3SGhjTgpNakl4TURFME1UTXlOREV5V2hjTk1qY3hNREV6TVRNeU5ERXlXakI3TVFzd0NRWURWUVFHRXdKVlV6RUxNQWtHCkExVUVDQk1DUTBFeEV6QVJCZ05WQkFjVENsTmhiblJoUTJ4aGNtRXhGVEFUQmdOVkJBb1RERk53WldOMGNtOUQKYkc5MVpERUxNQWtHQTFVRUN4TUNTVlF4SmpBa0JnTlZCQU1USFhCeWIzaDVMbk5oYlhCc1pTNXpjR1ZqZEhKdgpZMnh2ZFdRdVkyOXRNSUlCSWpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQXd5bEt3MmlxClBXM2JrQU0wV3RhaEFLbEppcWFHd05LUDVRRTZ6ZW5NM2FURko3TjIwN0dWcUNGYzJHTDNodmNhTDFranZjeEkKK2lybHpkbm9hcVhUSmV3ZkJiTGs2SGVhZmdXUVp3NHNNeE5QRUVYYlNXYm54Mm03Y2FlbVJiUWZSQWhPWXRvWgpIWG1IMzQ1Q25mNjF0RnhMeEEzb0JRNm1yb0JMVXNOOUh2WWFzeGE5QUFmZUNNZm5sYWVBWE9CVmROalJTN1VzCkN5NmlSRXpEWFgvem1nOG5WWFUwemlrcXdoS3pqSlBJd2FQa2ViaXVSdUJYdEZ0VlQwQmFzS3VqbURzd0lsRFQKVmR4SHRRQUVyUmM4Q2Nhb20yUkpZbTd1aHNEYlo2WVFzS3JiMmhIbU5rNENVWUd5eUJPZnBwbzR2bFd1S2FEcgpsVFNYUXlPN0M0ejM1d0lEQVFBQm8xNHdYREJhQmdOVkhSRUVVekJSZ2dsc2IyTmhiR2h2YzNTSEJIOEFBQUdDCkhYQnliM2g1TG5OaGJYQnNaUzV6Y0dWamRISnZZMnh2ZFdRdVkyOXRnaDhxTG5CeWIzaDVMbk5oYlhCc1pTNXoKY0dWamRISnZZMnh2ZFdRdVkyOXRNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUEvRFJFVm54SWJRdi9uMDEvSQpJd1d0ekhKNGNHOUp6UlB6dmszNUcvRGJOVzZYZ0M3djBoWlFIVHg5bzMrckxoSUFiWTNmbjc1VEtlN3hMRWpiCkI3M3pGWURJSStkYzM5NkQzZU51M2NxRGIvY01kYmlFalhod2ttZk9NRm9qMnpOdHJIdzFsSjA0QlNFMWw1YWgKMDk0Vy9aaEQ2YTVLU3B0cDh1YUpKVmNrejRYMEdRWjVPYjZadGdxZVVxNytqWVZOZ0tLQzJCMW1SNjMyMDNsZwozVFZmZEkrdmI3b292dVdOOFRBVG9qdXNuS25WMmRMeTFBOWViWXYwMEM3WWZ6Q0NhODgrN2dzTGhJaUJjRHBPClJkWjU3QStKanJmSU5IYy9vNm5YWFhDZ2h2YkFwUVk1QnFnMWIzYUpUZERNWThUY0hoQVVaQzB5eU04bXcwMnQKWHRRQwotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
          key: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFb3dJQkFBS0NBUUVBd3lsS3cyaXFQVzNia0FNMFd0YWhBS2xKaXFhR3dOS1A1UUU2emVuTTNhVEZKN04yCjA3R1ZxQ0ZjMkdMM2h2Y2FMMWtqdmN4SStpcmx6ZG5vYXFYVEpld2ZCYkxrNkhlYWZnV1FadzRzTXhOUEVFWGIKU1dibngybTdjYWVtUmJRZlJBaE9ZdG9aSFhtSDM0NUNuZjYxdEZ4THhBM29CUTZtcm9CTFVzTjlIdllhc3hhOQpBQWZlQ01mbmxhZUFYT0JWZE5qUlM3VXNDeTZpUkV6RFhYL3ptZzhuVlhVMHppa3F3aEt6akpQSXdhUGtlYml1ClJ1Qlh0RnRWVDBCYXNLdWptRHN3SWxEVFZkeEh0UUFFclJjOENjYW9tMlJKWW03dWhzRGJaNllRc0tyYjJoSG0KTms0Q1VZR3l5Qk9mcHBvNHZsV3VLYURybFRTWFF5TzdDNHozNXdJREFRQUJBb0lCQUFPVVZFeTFOTG9mczdFMgpmZFZVcm10R3I1U2RiVWRJRlYrTDREbzZtWWxQSmxhT0VoWGI0ZlROZDloNEtEWVBmaWwwSnhXcUU0U1RHTmZuCnNUMlRnUVhuQ01LZi8xYk1Lc2M0N3VjVStYYU9XaHJnVFI5UmhkckFjN0duODRLL3hQc0ljL2VZTEhHLzh1QUUKeWUvLzVmRkM2QmpXY0hUM1NkTlZnd3duamJudG5XTXIzTFJBVnJBamZBckxveWUwS0F2YytYdXJLTEVCcmMyVQpjaHlDbitZemJKN0VlSG44UXdQNGdBNXVSK0NCMFJPeFErYXIzS3M5YUhkZTQ1OEVNNEtLMnpUOXA4RWZRc1lFCkFtNUpxWjliR0JEVHV1dEkyNm9GK0pLQ1IzZzhXNERRcHVYRUZoVjlya0pMSm13RDhQb0JaclF6UzZvdmJhdkkKRk42QVM4RUNnWUVBOEcxQzFxZVh4dTQ4aEYxak5MTCswRmxkeWdFem9SMmFoRGJCai8weUZkQVVjU2pYTzk0NAozN1dORTBUUG10WG1Vc3NZTlBTR21XaWI2OUhicEFoMTY3SWVwNE9LaVlZdkozYm1oUC9WNzFvK3M0SWJlSHh1CkVJbWVVckFOZWRoQURVQnZ4c1lXRWxlVlVJSFFRcjY1VHM2ZjIrWkpTKzg4TU05bUorL3BmcmNDZ1lFQXo4MXgKR3JiSE5oak56RjhZMjhiK0hMNW5rdDR0SUdkU3hnbW9PMFFJeGkrQVNZTzB0WW42VFk0ZHI5ZXErMzE3b21ZawpMbDNtNENORDhudG1vYzRvWnM4SUpDQ0IrZjNqcTY4OHdoQU9vVHZ4dDhjZVJqOFRhRHl1SHZwS043OVNsVVd2CjBJd2ZRNDNIemd3SWJiSWhjcTRJVGswanI0VHdWbThia283VElGRUNnWUJoNnUzVXhHN0JHeGZVaE1BNW4waSsKREJkeGhPbkZEV3gzdW1FOHhrN1dxV2NaNnhzMWk3eTRCNVhNS2pNdkNUeURyYWxQTCtOOXFTZ1BjK216TmFybwo4aU1mOENmRStMeE5vMVFoQ0p6Vm5YaDUzVnhZeHJ5QXlidU1TNTFCYVh3MHFYQ2NrT0krV0NNOHBaSHZEUVFsCmYydUZ3SlZMY3NTZDBHbjNpL01ab3dLQmdBY1BzUjg2Uk15MnpROTd6OGx3R3FSNVorV2F2U2ZUdXdGVnhLeTIKNUNGdjdja1J1NnRMbEFEY3FtK1dRWTRvTm5KUFREMXpIV3hTWm5XdjhjM2Z4b212MFZRQThzbSs4ZVNjb05EcgpZTVBqMkpQcEpVTTMwMzRBU2Q1dG5PWUdEMVZaTjk4N1U3aWs4Ynd6dG5tYnl2MHRvc1NlWkc4TGNtdE5mVDllCnNSZnhBb0dCQUpTV1lDellyTlRMNnRUSnh5M2FqWm5jZkxrMEV0eWNCd05FRXZHVzVSVE9LOUFYTE96RzN0eHUKajZqWlRpaUFRU09aaVd0clJHU0U0bEkyQ1MvcjNjd3VuSGlnZlovd1dKZldkZ0JpRnZqOTVFbUVQWUZaRDRobQpkT3l5UHhRRXFTRmprQ21BS2plOFBpTDdpU01GbGhBZTZQWFljQlExdCtzd01UeXBnY3RrCi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0tCg==
        ca:
          crt : LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURNVENDQWhtZ0F3SUJBZ0lVSHhWK0ljVGZHUElzdW8yY3dqQ0Q0Z2RSTFFRd0RRWUpLb1pJaHZjTkFRRUwKQlFBd0tERW1NQ1FHQTFVRUF3d2RjSEp2ZUhrdWMyRnRjR3hsTG5Od1pXTjBjbTlqYkc5MVpDNWpiMjB3SGhjTgpNakl4TURFME1UTXlOREV5V2hjTk16WXdOakl5TVRNeU5ERXlXakFvTVNZd0pBWURWUVFEREIxd2NtOTRlUzV6CllXMXdiR1V1YzNCbFkzUnliMk5zYjNWa0xtTnZiVENDQVNJd0RRWUpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0MKQVFvQ2dnRUJBSy90WXBHVi9HRURUWnZzL25QQ2lOK0U3K1dOQ21GeU1NQjdkazVOT3JzQWZIaVVvZ1JRVUo0WQptSjhwVmYrSzhTRFBsdGNYcW40WVVTbmxiUERsVlBkWU5zOTEwT3RaS1EwNW96aUtGV2pNbS85NHlLSjVyVzNsCndDNEN0ayttUm9Ib0ZQQS81dmFVbVZHdlVadjlGY0JuL0pKN2F4WnRIQk1PRiticXQ0Zmd0ci9YMWdOeWhPVzUKZTVScGpESkozRjJTVnc5NUpBQSt4a3V3UitFSmVseEtnQVpxdDc0ejB4U2ROODZ0QzNtK0wxRGs2WVVlQWEzZApvM3Rsa3ZkeDV6dUJvSmI2QmpZWEV4UE1PbThRcHFNVWRLK3lDZUdrem9XQStDOUtFdGtVaERCWktENStNWXRZCktVMUh1RXJCbmw2Z3BuWTRlbzJjVTRxdkNwZzZ4S3NDQXdFQUFhTlRNRkV3SFFZRFZSME9CQllFRklKMkRkTjgKc2ZtVjRCT1ZFL0FjZ0VEejArNmlNQjhHQTFVZEl3UVlNQmFBRklKMkRkTjhzZm1WNEJPVkUvQWNnRUR6MCs2aQpNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVMQlFBRGdnRUJBQWhQVi9RMVl1YWVTOTZVCmhjVGQ4RWdJaHhpbHFiTWlTQm5WaVdrdlJzWk94UUIwNTFScWtwT3g0UTRsckdaOGVJWWc3T0trTTdzejhuTVQKL2pxS21sZDY0MzJCcURCMlNkNVp5ZFdReHAwU1laRTlnVWszYk9KRGtZVXQ4b1cvZDBWeG9uU05LQVN3QmZKaApWV1VZUUlpNm55K0ZZZmtuRFNvRnFlY2Z3SDBQQVUraXpnMkI3KzFkbko5YisyQ21IOUVCallOZ2hoNlFzVlFQCkh2SkdQQURtandPNkJOam5HK0Z3K0Z6cmFXUTNCTjAwb08zUjF6UmgxZERmTTQzR3oxRmZGRW5GSXI5aGFuUnQKWHJFZm8vZWU5bjBLWUFESEJnV1g4dlhuNHZrRmdWRjgwYW9MUUJSQTBxWXErcW1pVlp6YnREeE9ldFEyRWFyTQpyNmVWL0lZPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==

    UI System

    The table lists parameters for the Network Operations Center User Interface (NOC UI). Palette's NOC UI enables easy location monitoring of multi-location clusters through an intuitive UI.

    Parameters Default ValueTypeDescriptionRequired/Optional
    enabledfalseBooleanSpecifies if the NOC UI is enabled or not.Optional
    mapBoxAccessToken""StringAccess token for the MapBox API.Optional
    mapBoxStyledLayerID""StringID for the MapBox style layer.Optional
    ui-system:
      ui:
        nocUI:
          enable: false
          mapBoxAccessToken: ""
          mapBoxStyledLayerID: ""
    Edit on GitHub