def test_backup_ldap(monkeypatch, settings, given, expected):
from pygluu.kubernetes.terminal.backup import PromptBackup
monkeypatch.setattr("click.prompt", lambda x, default: given or expected)
settings.set("PERSISTENCE_BACKEND", "ldap")
PromptBackup(settings).prompt_backup()
assert settings.get("LDAP_BACKUP_SCHEDULE") == expected
def test_backup_ldap(monkeypatch, settings, given, expected):
from pygluu.kubernetes.terminal.backup import PromptBackup
monkeypatch.setattr("click.prompt", lambda x, default: given or expected)
settings.set("global.cnPersistenceType", "ldap")
PromptBackup(settings).prompt_backup()
assert settings.get(
"installer-settings.ldap.backup.fullSchedule") == expected
def test_backup_fullschedule(monkeypatch, settings):
from pygluu.kubernetes.terminal.backup import PromptBackup
monkeypatch.setattr("click.prompt", lambda x, default: "0 2 * * 6")
settings.set("global.cnPersistenceType", "couchbase")
settings.set("installer-settings.couchbase.backup.fullSchedule", "")
PromptBackup(settings).prompt_backup()
assert settings.get(
"installer-settings.couchbase.backup.fullSchedule") == "0 2 * * 6"
def test_backup_not_ldap_full(monkeypatch, settings, given, expected, type_):
from pygluu.kubernetes.terminal.backup import PromptBackup
monkeypatch.setattr("click.prompt", lambda x, default: given or expected)
settings.set("PERSISTENCE_BACKEND", type_)
settings.set("COUCHBASE_INC_BACKUP_SCHEDULE", "*/30 * * * *")
settings.set("COUCHBASE_BACKUP_RETENTION_TIME", "168h")
settings.set("COUCHBASE_BACKUP_STORAGE_SIZE", "20Gi")
PromptBackup(settings).prompt_backup()
assert settings.get("COUCHBASE_FULL_BACKUP_SCHEDULE") == expected
def test_backup_not_ldap_full(monkeypatch, settings, given, expected, type_):
from pygluu.kubernetes.terminal.backup import PromptBackup
monkeypatch.setattr("click.prompt", lambda x, default: given or expected)
settings.set("global.cnPersistenceType", type_)
settings.set("installer-settings.couchbase.backup.incrementalSchedule",
"*/30 * * * *")
settings.set("installer-settings.couchbase.backup.retentionTime", "168h")
settings.set("installer-settings.couchbase.backup.storageSize", "20Gi")
PromptBackup(settings).prompt_backup()
assert settings.get(
"installer-settings.couchbase.backup.incrementalSchedule") == expected
def backup(self):
self.load_settings()
if self.settings.get("DEPLOYMENT_ARCH") not in ("microk8s",
"minikube"):
backup = PromptBackup(self.settings)
backup.prompt_backup()
def __init__(self, settings):
self.settings = settings
self.backup = PromptBackup(self.settings)
self.arch = PromptArch(self.settings)
self.namespace = PromptNamespace(self.settings)
class PromptCouchbase:
"""Prompt is used for prompting users for input used in deploying Gluu.
"""
def __init__(self, settings):
self.settings = settings
self.backup = PromptBackup(self.settings)
self.arch = PromptArch(self.settings)
self.namespace = PromptNamespace(self.settings)
def prompt_couchbase(self):
self.arch.prompt_arch()
self.namespace.prompt_gluu_namespace()
if self.settings.get("DEPLOYMENT_ARCH") not in ("microk8s",
"minikube"):
self.backup.prompt_backup()
if not self.settings.get("HOST_EXT_IP"):
ip = gather_ip
self.settings.set("HOST_EXT_IP", ip)
if not self.settings.get("INSTALL_COUCHBASE"):
logger.info(
"For the following prompt if placed [N] the couchbase is assumed to be"
" installed or remotely provisioned")
self.settings.set("INSTALL_COUCHBASE",
confirm_yesno("Install Couchbase", default=True))
if self.settings.get("INSTALL_COUCHBASE") == "N":
if not self.settings.get("COUCHBASE_CRT"):
print(
"Place the Couchbase certificate authority certificate in a file called couchbase.crt at "
"the same location as the installation script.")
print(
"This can also be found in your couchbase UI Security > Root Certificate"
)
_ = input("Hit 'enter' or 'return' when ready.")
with open(Path("./couchbase.crt")) as content_file:
ca_crt = content_file.read()
encoded_ca_crt_bytes = base64.b64encode(
ca_crt.encode("utf-8"))
encoded_ca_crt_string = str(encoded_ca_crt_bytes, "utf-8")
self.settings.set("COUCHBASE_CRT", encoded_ca_crt_string)
else:
self.settings.set("COUCHBASE_CRT", "")
self.prompt_override_couchbase_files()
if self.settings.get("DEPLOYMENT_ARCH") in ("microk8s", "minikube"):
self.settings.set("COUCHBASE_USE_LOW_RESOURCES", "Y")
if not self.settings.get("COUCHBASE_USE_LOW_RESOURCES"):
self.settings.set(
"COUCHBASE_USE_LOW_RESOURCES",
confirm_yesno(
"Setup CB nodes using low resources for demo purposes"))
if self.settings.get("COUCHBASE_USE_LOW_RESOURCES") == "N" and \
self.settings.get("COUCHBASE_CLUSTER_FILE_OVERRIDE") == "N" and \
self.settings.get("INSTALL_COUCHBASE") == "Y":
self.prompt_couchbase_calculator()
if not self.settings.get("COUCHBASE_NAMESPACE"):
self.settings.set(
"COUCHBASE_NAMESPACE",
click.prompt("Please enter a namespace for CB objects.",
default="cbns"))
if not self.settings.get("COUCHBASE_CLUSTER_NAME"):
self.settings.set(
"COUCHBASE_CLUSTER_NAME",
click.prompt("Please enter a cluster name.", default="cbgluu"))
if not self.settings.get("COUCHBASE_URL"):
self.settings.set(
"COUCHBASE_URL",
click.prompt(
"Please enter couchbase (remote or local) URL base name",
default=
f"{self.settings.get('COUCHBASE_CLUSTER_NAME')}.{self.settings.get('COUCHBASE_NAMESPACE')}.svc"
f".cluster.local",
))
if not self.settings.get("COUCHBASE_INDEX_NUM_REPLICA"):
self.settings.set(
"COUCHBASE_INDEX_NUM_REPLICA",
click.prompt(
"Please enter the number of replicas per index created. "
"Please note that the number of index nodes must be one greater than the number of replicas. "
"That means if your couchbase cluster only has 2 "
"index nodes you cannot place the number of replicas to be higher than 1.",
default="0",
))
if not self.settings.get("COUCHBASE_SUPERUSER"):
self.settings.set(
"COUCHBASE_SUPERUSER",
click.prompt("Please enter couchbase superuser username.",
default="admin"))
if not self.settings.get("COUCHBASE_SUPERUSER_PASSWORD"):
self.settings.set("COUCHBASE_SUPERUSER_PASSWORD",
prompt_password("Couchbase superuser"))
if not self.settings.get("COUCHBASE_USER"):
self.settings.set(
"COUCHBASE_USER",
click.prompt("Please enter gluu couchbase username.",
default="gluu"))
if not self.settings.get("COUCHBASE_PASSWORD"):
self.settings.set("COUCHBASE_PASSWORD",
prompt_password("Couchbase Gluu user"))
self.find_couchbase_certs_or_set_san_cn()
def prompt_override_couchbase_files(self):
if not self.settings.get("COUCHBASE_CLUSTER_FILE_OVERRIDE"):
self.settings.set(
"COUCHBASE_CLUSTER_FILE_OVERRIDE",
confirm_yesno(
"Override couchbase-cluster.yaml with a custom couchbase-cluster.yaml",
))
if self.settings.get("COUCHBASE_CLUSTER_FILE_OVERRIDE") == "Y":
try:
shutil.copy(Path("./couchbase-cluster.yaml"),
Path("./couchbase/couchbase-cluster.yaml"))
shutil.copy(Path("./couchbase-buckets.yaml"),
Path("./couchbase/couchbase-buckets.yaml"))
shutil.copy(
Path("./couchbase-ephemeral-buckets.yaml"),
Path("./couchbase/couchbase-ephemeral-buckets.yaml"))
except FileNotFoundError:
logger.error(
"An override option has been chosen but there is a missing couchbase file that "
"could not be found at the current path. Please place the override files under the name"
" couchbase-cluster.yaml, couchbase-buckets.yaml, and couchbase-ephemeral-buckets.yaml"
" in the same directory pygluu-kubernetes.pyz exists ")
raise SystemExit(1)
def find_couchbase_certs_or_set_san_cn(self):
"""Finds couchbase certs inside couchbase_crts-keys folder and if not existent sets couchbase SAN and prompts
for couchbase common name.
"""
custom_cb_ca_crt = Path("./couchbase_crts_keys/ca.crt")
custom_cb_crt = Path("./couchbase_crts_keys/chain.pem")
custom_cb_key = Path("./couchbase_crts_keys/pkey.key")
if not custom_cb_ca_crt.exists(
) or not custom_cb_crt.exists() and not custom_cb_key.exists():
if not self.settings.get('COUCHBASE_SUBJECT_ALT_NAME'):
self.settings.set('COUCHBASE_SUBJECT_ALT_NAME', [
"*.{}".format(self.settings.get("COUCHBASE_CLUSTER_NAME")),
"*.{}.{}".format(
self.settings.get("COUCHBASE_CLUSTER_NAME"),
self.settings.get("COUCHBASE_NAMESPACE")),
"*.{}.{}.svc".format(
self.settings.get("COUCHBASE_CLUSTER_NAME"),
self.settings.get("COUCHBASE_NAMESPACE")),
"{}-srv".format(
self.settings.get("COUCHBASE_CLUSTER_NAME")),
"{}-srv.{}".format(
self.settings.get("COUCHBASE_CLUSTER_NAME"),
self.settings.get("COUCHBASE_NAMESPACE")),
"{}-srv.{}.svc".format(
self.settings.get("COUCHBASE_CLUSTER_NAME"),
self.settings.get("COUCHBASE_NAMESPACE")), "localhost"
])
if not self.settings.get("COUCHBASE_CN"):
self.settings.set(
"COUCHBASE_CN",
click.prompt("Enter Couchbase certificate common name.",
default="Couchbase CA"))
def prompt_couchbase_calculator(self):
"""Attempt to Calculate resources needed
"""
if not self.settings.get("NUMBER_OF_EXPECTED_USERS"):
self.settings.set(
"NUMBER_OF_EXPECTED_USERS",
click.prompt(
"Please enter the number of expected users "
"[alpha]",
default="1000000"))
if not self.settings.get(
"USING_RESOURCE_OWNER_PASSWORD_CRED_GRANT_FLOW"):
self.settings.set(
"USING_RESOURCE_OWNER_PASSWORD_CRED_GRANT_FLOW",
confirm_yesno(
"Will you be using the resource owner password credential grant flow [alpha]",
default=True,
))
if not self.settings.get("USING_CODE_FLOW"):
self.settings.set(
"USING_CODE_FLOW",
confirm_yesno("Will you be using the code flow [alpha]",
default=True))
if not self.settings.get("USING_SCIM_FLOW"):
self.settings.set(
"USING_SCIM_FLOW",
confirm_yesno("Will you be using the SCIM flow [alpha]",
default=True))
if not self.settings.get("EXPECTED_TRANSACTIONS_PER_SEC"):
self.settings.set(
"EXPECTED_TRANSACTIONS_PER_SEC",
click.prompt("Expected transactions per second [alpha]",
default=2000))
# couchbase-cluster.yaml specs
if not self.settings.get("COUCHBASE_DATA_NODES"):
self.settings.set(
"COUCHBASE_DATA_NODES",
click.prompt(
"Please enter the number of data nodes. [alpha] (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_INDEX_NODES"):
self.settings.set(
"COUCHBASE_INDEX_NODES",
click.prompt(
"Please enter the number of index nodes. [alpha] (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_QUERY_NODES"):
self.settings.set(
"COUCHBASE_QUERY_NODES",
click.prompt(
"Please enter the number of query nodes. [alpha] (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_SEARCH_EVENTING_ANALYTICS_NODES"):
self.settings.set(
"COUCHBASE_SEARCH_EVENTING_ANALYTICS_NODES",
click.prompt(
"Please enter the number of search, eventing and analytics nodes. [alpha] (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_GENERAL_STORAGE"):
self.settings.set(
"COUCHBASE_GENERAL_STORAGE",
click.prompt(
"Please enter the general storage size used for couchbase. [alpha] (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_DATA_STORAGE"):
self.settings.set(
"COUCHBASE_DATA_STORAGE",
click.prompt(
"Please enter the data node storage size used for couchbase. [alpha] (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_INDEX_STORAGE"):
self.settings.set(
"COUCHBASE_INDEX_STORAGE",
click.prompt(
"Please enter the index node storage size used for couchbase. (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_QUERY_STORAGE"):
self.settings.set(
"COUCHBASE_QUERY_STORAGE",
click.prompt(
"Please enter the query node storage size used for couchbase. (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_ANALYTICS_STORAGE"):
self.settings.set(
"COUCHBASE_ANALYTICS_STORAGE",
click.prompt(
"Please enter the analytics node storage size used for couchbase. (auto-calculated)",
default="",
))
if not self.settings.get("COUCHBASE_VOLUME_TYPE"):
logger.info("GCE GKE Options ('pd-standard', 'pd-ssd')")
logger.info("AWS EKS Options ('gp2', 'io1', 'st1', 'sc1')")
logger.info(
"Azure Options ('Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS')"
)
self.settings.set(
"COUCHBASE_VOLUME_TYPE",
click.prompt("Please enter the volume type.", default="io1"))
def prompt_couchbase_multi_cluster(self):
"""Prompts for couchbase multi cluster
"""
print(
"|------------------------------------------------------------------|"
)
print(
"| Is this a multi-cloud/region setup[N] ? [Y/N] |"
)
print(
"|------------------------------------------------------------------|"
)
print(
"| Notes |"
)
print(
"|------------------------------------------------------------------|"
)
print(
"If you are planning for a multi-cloud/region setup and this is the first cluster answer N or"
" leave blank. You will answer Y for the second and more cluster setup "
)
print(
"|------------------------------------------------------------------|"
)
self.settings.set("DEPLOY_MULTI_CLUSTER",
confirm_yesno("Is this a multi-cloud/region setup"))
def backup(self):
self.load_settings()
if self.settings.get("global.storageClass.provisioner") not in (
"microk8s.io/hostpath", "k8s.io/minikube-hostpath"):
backup = PromptBackup(self.settings)
backup.prompt_backup()
class PromptCouchbase:
"""Prompt is used for prompting users for input used in deploying Gluu.
"""
def __init__(self, settings):
self.settings = settings
self.backup = PromptBackup(self.settings)
self.arch = PromptArch(self.settings)
self.namespace = PromptNamespace(self.settings)
def prompt_couchbase(self):
self.arch.prompt_arch()
self.namespace.prompt_gluu_namespace()
if self.settings.get("global.storageClass.provisioner") \
not in ("microk8s.io/hostpath", "k8s.io/minikube-hostpath"):
self.backup.prompt_backup()
if self.settings.get("global.lbIp") in (None, ''):
ip = gather_ip
self.settings.set("global.lbIp", ip)
if self.settings.get("installer-settings.couchbase.install") in (None, ''):
logger.info("For the following prompt if placed [N] the couchbase is assumed to be"
" installed or remotely provisioned")
self.settings.set("installer-settings.couchbase.install", click.confirm("Install Couchbase",
default=True))
if not self.settings.get("installer-settings.couchbase.install"):
if self.settings.get("config.configmap.cnCouchbaseCrt") in (None, ''):
print("Place the Couchbase certificate authority certificate in a file called couchbase.crt at "
"the same location as the installation script.")
print("This can also be found in your couchbase UI Security > Root Certificate")
_ = input("Hit 'enter' or 'return' when ready.")
with open(Path("./couchbase.crt")) as content_file:
ca_crt = content_file.read()
encoded_ca_crt_bytes = base64.b64encode(ca_crt.encode("utf-8"))
encoded_ca_crt_string = str(encoded_ca_crt_bytes, "utf-8")
self.settings.set("config.configmap.cnCouchbaseCrt", encoded_ca_crt_string)
else:
self.settings.set("config.configmap.cnCouchbaseCrt", "")
self.prompt_override_couchbase_files()
if self.settings.get("global.storageClass.provisioner") \
in ("microk8s.io/hostpath", "k8s.io/minikube-hostpath"):
self.settings.set("installer-settings.couchbase.lowResourceInstall", True)
if self.settings.get("installer-settings.couchbase.lowResourceInstall") in (None, ''):
self.settings.set("installer-settings.couchbase.lowResourceInstall", click.confirm(
"Setup CB nodes using low resources for demo purposes"))
if not self.settings.get("installer-settings.couchbase.lowResourceInstall") and \
not self.settings.get("installer-settings.couchbase.customFileOverride") and \
self.settings.get("installer-settings.couchbase.install"):
self.prompt_couchbase_yaml()
if self.settings.get("installer-settings.couchbase.namespace") in (None, ''):
self.settings.set("installer-settings.couchbase.namespace",
click.prompt("Please enter a namespace for CB objects.", default="cbns"))
if self.settings.get("installer-settings.couchbase.clusterName") in (None, ''):
self.settings.set("installer-settings.couchbase.clusterName",
click.prompt("Please enter a cluster name.", default="cbgluu"))
if self.settings.get("config.configmap.cnCouchbaseUrl") in (None, ''):
self.settings.set("config.configmap.cnCouchbaseUrl", click.prompt(
"Please enter couchbase (remote or local) URL base name",
default=f"{self.settings.get('installer-settings.couchbase.clusterName')}."
f"{self.settings.get('installer-settings.couchbase.namespace')}.svc.cluster.local",
))
if self.settings.get("config.configmap.cnCouchbaseBucketPrefix") in (None, ''):
self.settings.set("config.configmap.cnCouchbaseBucketPrefix", click.prompt(
"Please enter a prefix name for all couchbase gluu buckets",
default="gluu"
))
if self.settings.get("config.configmap.cnCouchbaseIndexNumReplica") in (None, ''):
self.settings.set("config.configmap.cnCouchbaseIndexNumReplica", click.prompt(
"Please enter the number of replicas per index created. "
"Please note that the number of index nodes must be one greater than the number of replicas. "
"That means if your couchbase cluster only has 2 "
"index nodes you cannot place the number of replicas to be higher than 1.",
default="0",
))
if self.settings.get("config.configmap.cnCouchbaseSuperUser") in (None, ''):
self.settings.set("config.configmap.cnCouchbaseSuperUser",
click.prompt("Please enter couchbase superuser username.", default="admin"))
if self.settings.get("config.configmap.cnCouchbaseSuperUserPassword") in (None, ''):
self.settings.set("config.configmap.cnCouchbaseSuperUserPassword", prompt_password("Couchbase superuser"))
if self.settings.get("config.configmap.cnCouchbaseUser") in (None, ''):
self.settings.set("config.configmap.cnCouchbaseUser",
click.prompt("Please enter gluu couchbase username.", default="gluu"))
if self.settings.get("config.configmap.cnCouchbasePassword") in (None, ''):
self.settings.set("config.configmap.cnCouchbasePassword", prompt_password("Couchbase Gluu user"))
self.find_couchbase_certs_or_set_san_cn()
def prompt_override_couchbase_files(self):
if self.settings.get("installer-settings.couchbase.customFileOverride") in (None, ''):
self.settings.set("installer-settings.couchbase.customFileOverride", click.confirm(
"Override couchbase-cluster.yaml with a custom couchbase-cluster.yaml",
))
if self.settings.get("installer-settings.couchbase.customFileOverride"):
try:
shutil.copy(Path("./couchbase-cluster.yaml"), Path("./couchbase/couchbase-cluster.yaml"))
shutil.copy(Path("./couchbase-buckets.yaml"), Path("./couchbase/couchbase-buckets.yaml"))
shutil.copy(Path("./couchbase-ephemeral-buckets.yaml"),
Path("./couchbase/couchbase-ephemeral-buckets.yaml"))
except FileNotFoundError:
logger.error("An override option has been chosen but there is a missing couchbase file that "
"could not be found at the current path. Please place the override files under the name"
" couchbase-cluster.yaml, couchbase-buckets.yaml, and couchbase-ephemeral-buckets.yaml"
" in the same directory pygluu-kubernetes.pyz exists ")
raise SystemExit(1)
def find_couchbase_certs_or_set_san_cn(self):
"""Finds couchbase certs inside couchbase_crts-keys folder and if not existent sets couchbase SAN and prompts
for couchbase common name.
"""
custom_cb_ca_crt = Path("./couchbase_crts_keys/ca.crt")
custom_cb_crt = Path("./couchbase_crts_keys/chain.pem")
custom_cb_key = Path("./couchbase_crts_keys/pkey.key")
if not custom_cb_ca_crt.exists() or not custom_cb_crt.exists() and not custom_cb_key.exists():
if self.settings.get('installer-settings.couchbase.subjectAlternativeName') in (None, ''):
self.settings.set('installer-settings.couchbase.subjectAlternativeName', [
"*.{}".format(self.settings.get("installer-settings.couchbase.clusterName")),
"*.{}.{}".format(self.settings.get("installer-settings.couchbase.clusterName"),
self.settings.get("installer-settings.couchbase.namespace")),
"*.{}.{}.svc".format(self.settings.get("installer-settings.couchbase.clusterName"),
self.settings.get("installer-settings.couchbase.namespace")),
"*.{}.{}.svc.cluster.local".format(self.settings.get("installer-settings.couchbase.clusterName"),
self.settings.get("installer-settings.couchbase.namespace")),
"{}-srv".format(self.settings.get("installer-settings.couchbase.clusterName")),
"{}-srv.{}".format(self.settings.get("installer-settings.couchbase.clusterName"),
self.settings.get("installer-settings.couchbase.namespace")),
"{}-srv.{}.svc".format(self.settings.get("installer-settings.couchbase.clusterName"),
self.settings.get("installer-settings.couchbase.namespace")),
"*.{}-srv.{}.svc.cluster.local".format(
self.settings.get("installer-settings.couchbase.clusterName"),
self.settings.get("installer-settings.couchbase.namespace")),
"localhost"
])
if self.settings.get("installer-settings.couchbase.commonName") in (None, ''):
self.settings.set("installer-settings.couchbase.commonName",
click.prompt("Enter Couchbase certificate common name.", default="Couchbase CA"))
def prompt_couchbase_yaml(self):
"""
Used to generate couchbase cluster yaml
"""
if not self.settings.get('installer-settings.couchbase.totalNumberOfExpectedUsers'):
self.settings.set('installer-settings.couchbase.totalNumberOfExpectedUsers',
click.prompt("Please enter the number of expected users", default="1000000"))
if not self.settings.get('installer-settings.couchbase.totalNumberOfExpectedTransactionsPerSec'):
self.settings.set('installer-settings.couchbase.totalNumberOfExpectedTransactionsPerSec',
click.prompt("Expected transactions per second [alpha]",
default=2000))
if not self.settings.get('installer-settings.couchbase.volumeType'):
logger.info("GCE GKE Options ('pd-standard', 'pd-ssd')")
logger.info("AWS EKS Options ('gp2', 'io1', 'st1', 'sc1')")
logger.info("Azure Options ('Standard_LRS', 'Premium_LRS', 'StandardSSD_LRS', 'UltraSSD_LRS')")
self.settings.set('installer-settings.couchbase.volumeType', click.prompt("Please enter the volume type.",
default="io1"))