WikiSysop at 08:31, March 27, 2023

2023-03-27T08:31:52Z

WikiSysop: Created page with "{{Article |Standalone=No |DisplayName=Consul requirements for Voice services |TocName=Consul requirements for Voice services |Context=Find details about Voice services setting..."

2022-10-13T14:30:54Z

Created page with "{{Article |Standalone=No |DisplayName=Consul requirements for Voice services |TocName=Consul requirements for Voice services |Context=Find details about Voice services setting..."

New page

{{Article
|Standalone=No
|DisplayName=Consul requirements for Voice services
|TocName=Consul requirements for Voice services
|Context=Find details about Voice services settings that you must configure in Consul before you proceed to configure the Voice Microservices. Some of the configuration in Consul must be performed when you deploy Consul.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=Before you deploy the Voice Services, you must deploy the infrastructure services. See {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Planning|anchor=ThirdParty|display text=Third-party prerequisites}} for the list of required infrastructure services.

It is your responsibility to deploy and manage all required third-party services, however – in addition to any other Consul configuration you require – there are specific Consul features that you must enable for Voice services.

Complete the work on this page before you make any changes described in {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Configure|display text=Configure Voice Microservices}}.
|Status=No
}}{{Section
|sectionHeading=Configure Consul features for Voice services
|anchor=ConsulConfig
|alignment=Vertical
|structuredtext=You can find system-level information about Consul on the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites|display text=Software requirements}}, {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigNetwork|display text=Network settings}}, and {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ContDepOrder|display text=Order of services deployment}} pages in ''Setting up Genesys Multicloud CX Private Edition''.

When you deploy Consul, you must enable the following features for the Voice services:

*connectinject – To deploy sidecar containers in Voice pods.
*controller – To provide service intention functionality.
*openshift – To set OpenShift-specific permissions.
*syncCatalog – To sync Kubernetes services to Consul. Set '''toK8S: false''' and '''addK8SNamespaceSuffix: false''' for syncing services from Kubernetes to Consul.
*AccessControlList – To enable ACL, set '''manageSystemACLs: true'''.
*storageclass – To set the storage class to a predefined storage class.
*TLS – To enable TLS, set '''enabled: true'''. Additional information is required to set up TLS; the following sample includes that information.

The following sample shows the features configuration in Consul:<source lang="text">
# config.yaml
global:
name: consul
tls:
enabled: true
caCert:
secretName: consul-ca-cert
# The key of the Kubernetes secret.
secretKey: tls.crt
caKey:
# The name of the Kubernetes secret.
secretName: consul-ca-key
# The key of the Kubernetes secret.
secretKey: tls.key
acls:
manageSystemACLs: true
openshift:
enabled: true
connectInject:
enabled: true
controller:
enabled: true
syncCatalog:
enabled: true
toConsul: true
toK8S: false
addK8SNamespaceSuffix: false
</source>
|Status=No
}}{{Section
|sectionHeading=Create a Consul bootstrap token
|anchor=ConsulTokens
|alignment=Vertical
|structuredtext=When you enable an Access Control List (ACL) in Consul, you must ensure that Voice services have access to read and write to Consul. To provide access, you create a token with permissions for Voice services in the Consul UI.

#You can create the ACL bootstrap token when you deploy Consul, although it is possible to do this configuration later as part of the Voice Services deployment. You use the bootstrap token to log into the Consul UI to create a new ACL. Use the following command to get the bootstrap token:
#:<source lang="text">
kubectl get secret consul-bootstrap-acl-token -n <consul namespace> -o go-template='{{.data.token | base64decode}}
</source>
#Create a new token to which you'll assign the permissions required for Voice services. For example, we'll create a token with a value of <tt>a7529f8a-1146-e398-8bd7-367894c4b37b</tt>. You create a Kubernetes secret with this token. For example:
#:<source lang="text">
kubectl create secret generic consul-voice-token -n voice --from-literal='consul-consul-voice-token=a7529f8a-1146-e398-8bd7-367894c4b37b'
</source>
#Create a policy (voice-policy) with the following list of permissions and assign it to the new token:
#:<source lang="text">
service_prefix "" {
policy = "read"
intentions = "read"
}
service_prefix "" {
policy = "write"
intentions = "write"
}
node_prefix "" {
policy = "read"
}
node_prefix "" {
policy = "write"
}
agent_prefix "" {
policy = "read"
}
agent_prefix "" {
policy = "write"
}
session_prefix "" {
policy = "write"
}
session_prefix "" {
policy = "read"
}
namespace_prefix "" {
key_prefix "" {
policy = "write"
}
session_prefix "" {
policy = "write"
}
}
key_prefix "" {
policy = "read"
}
key_prefix "" {
policy = "write"
}
</source>
|Status=No
}}{{Section
|sectionHeading=Create Intentions in the Consul UI
|alignment=Vertical
|structuredtext=Voice services use the Consul service mesh to connect between services. Consul has provision to either allow or deny the connection between services. This is done using ''intentions''. Log into the '''Intentions''' tab using the bootstrap token and create a new intention to allow all source services to all destination services as shown in the following screenshot.

[[File:voicemcs_config_consul_intentions.png|850px|link=https://all.docs-qa.genesys.com/File:Voicemcs_config_consul_intentions.png]]
|Status=No
}}
}}

@@ Line 23: / Line 23: @@
 *connectinject – To deploy sidecar containers in Voice pods.
 *controller – To provide service intention functionality.
 *syncCatalog – To sync Kubernetes services to Consul. Set '''toK8S: false''' and '''addK8SNamespaceSuffix: false''' for syncing services from Kubernetes to Consul.
 *AccessControlList – To enable ACL, set '''manageSystemACLs: true'''.
@@ Line 46: / Line 45: @@
    acls:
      manageSystemACLs: true
 connectInject:
    enabled: true

VM/Current/VMPEGuide/DeployConsul - Revision history

WikiSysop at 08:31, March 27, 2023

WikiSysop: Created page with "{{Article |Standalone=No |DisplayName=Consul requirements for Voice services |TocName=Consul requirements for Voice services |Context=Find details about Voice services setting..."