Adding current state of project

Author: Philipose

.gitignore

@@ -0,0 +1,16 @@
+*.pyc
+
+jsons/*
+txt/*
+variable_sets/*
+scripts/*
+templates/*
+
+.vscode/
+
+user_variables.py
+sandbox_script.py
+
+!variable_sets/template.py
+!scripts/template.py
+!scripts/change_pythonpath.py

Documentation/EXAMPLES.md

@@ -0,0 +1,20 @@
+# Examples
+
+## Use Cases - Aaron/"Philly"
+
+### Weekly Metrics
+I report the number of users, the number of applications onboarded, and number of hosts that are being monitored by Dynatrace.<br/>
+Check out the "examples" git branch for aaron_weekly_metrics.py
+
+### List of Host Groups
+We keep a document of all the different Host Groups that we are using. So I use a script occasionally to update the document of all the host groups in each environment.<br/>
+Check out the "examples" git branch for aaron_host_groups.py
+
+### Host Units by Management Zone
+Like many clients, my client uses a single tenant for NonProd and another tenant for Prod. Application teams are split by Management Zones. To track how many host units each team is using, I created a script to get the number of Host Units in use by each team.
+
+### Onboarding New Applications
+When onboarding a new application, I run this script. It will create all the user_groups required as well as the management zones needed for the different lifecycles of the application
+
+### Backend for Django Project
+Implementing this project as a backend for a Django-based web application. Stay tuned!

Documentation/GETTING_STARTED.md

@@ -0,0 +1,33 @@
+# Installation
+*Installation steps required to run the toolkit<br/>
+If you see a TODO for something related, please reach out to Aaron Philipose on Slack, Email, or Zoom*
+
+## Windows
+
+### Script Install
+- Open Command Line (cmd) and navigate to the Git Directory
+- Navigate to setup folder
+- Run "powershell.exe -ExecutionPolicy bypass .\install_python.ps1"
+
+
+### Install indepentantly
+- [Download the latest version of Python 3](https://www.python.org/downloads/)
+- Run the installer 
+  - Use default options.
+  - Select to add PYTHON_HOME to PATH
+- Open PowerShell or Command Line
+  - run "python -m pip install requests"
+### Through Company Software Request
+- For machines that require Company provided installs, any python version >= 3.4
+
+## Linux
+
+### RHEL, CentOS & Fedora
+
+- Run "sudo yum install python3 python3-pip"
+- Run "python3 -m pip install requests"
+
+### Ubuntu & Debian
+
+- Run "sudo apt-get install python3 python3-pip"
+- Run "python3 -m pip install requests"

Documentation/HOWTO.md

@@ -0,0 +1,20 @@
+# Language
+
+
+## Tenant, Cluster & Set
+Tenant - Dynatrace Tenant (aka *Dynatrace Environment*)<br/>
+Cluster - Dynatrace Cluster (SaaS can have all tenants under 1 "cluster")<br/>
+Set - All defined Dynatrace Clusters in user variables<br/>
+
+### Referencing Tenant, Cluster & Set
+Tenant -> function (uv.FULL_SET['CLUSTER_NAME'], "Tenant")<br/>
+Cluster -> function (uv.FULL_SET['CLUSTER_NAME])<br/>
+Set -> function (uv.FULL_SET)<br/>
+
+
+## Environment and App
+Environment - Customer Environments/Lifecycles (e.g. Dev/Test/Perf/Acpt/Prod/DR)<br/>
+App - Customer Applications (used with Tagging and MZ Rules)<br/>
+
+## Python Descriptions
+Dict - Python Dictionary (Note: API calls that use JSON payloads should pass in Dicts, and responses will be converted to Dicts)

Documentation/INSTALLATION.md

@@ -0,0 +1,5 @@
+# Project Objectives
+
+1. Lower the barrier of entry of creating repeatable Dynatrace scripts 
+2. Easy to Understand (Less time learning another new thing and more time using!)
+3. Allow other applications to implement this as a foundation ()

Documentation/LANGUAGE.md

@@ -0,0 +1,15 @@
+"""Replace active variables with another set"""
+import sys
+import os
+
+def replace_env():
+  """Replace Variable File"""
+  print("Enter Set to Import: ", end='')
+  new_env = input()
+
+  if "win" in sys.platform:
+    os.system("copy variable_sets\\" + str(new_env) + ".py user_variables.py")
+  else:
+    os.system("cp variable_sets/" + str(new_env) + ".py user_variables.py")
+
+replace_env()

Documentation/MODULE_GLOSSARY.md

@@ -0,0 +1,13 @@
+import dynatrace.requests.request_handler as rh
+
+def get_node_info(cluster):
+  response = rh.cluster_get(cluster,"cluster")
+  return response.json()
+
+def get_node_config(cluster):
+  response = rh.cluster_get(cluster,"cluster/configuration")
+  return response.json()
+
+def set_node_config(cluster, json):
+  response = rh.cluster_post(cluster,"cluster/configuration", json=json)
+  return response.status_code

Documentation/PROJECT_OBJECTIVES.md

@@ -0,0 +1,29 @@
+#!/bin/python3
+"""Cluster SSL Certificate Operations"""
+import dynatrace.requests.request_handler as rh
+
+def get_cert_details(cluster, entity_type, entity_id):
+  """Get SSL Certificate information for Server or Cluster ActiveGate"""
+  response = rh.cluster_get(
+      cluster,
+      "sslCertificate/" + str(entity_type) + "/" + str(entity_id)
+  )
+  return response.json()
+
+def get_cert_install_status(cluster, entity_id):
+  """Get SSL Storage Status for Cluster ActiveGate"""
+  response = rh.cluster_get(
+      cluster,
+      "sslCertificate/store/COLLECTOR/" + str(entity_id)
+  )
+  return response.text
+
+def set_cert(cluster, entity_type, entity_id, ssl_json):
+  """Set SSL Storage Status for Server or Cluster ActiveGate"""
+  response = rh.cluster_post(
+      cluster,
+      "sslCertificate/store/" + str(entity_type) + "/" + str(entity_id),
+      json=ssl_json
+  )
+  return response.json()
+

change_variables.py

@@ -0,0 +1,38 @@
+"""SSO Operations for Dynatrace"""
+import dynatrace.requests.request_handler as rh
+
+def disable_sso (cluster):
+  """Disable SSO Sign-in"""
+  disable_payload = {
+      "ssoProvider": "NONE",
+      "loginPage": "STANDARD",
+      "ssoEnabled": False,
+      "ssoGroupsEnabled": False,
+      "ssoLoginDisabled": True
+  }
+  response = rh.cluster_post(cluster, "sso/ssoProvider", json=disable_payload)
+  return response.status_code
+
+def enable_sso(cluster, disable_local=False, groups_enabled=False, is_openid=False):
+  """Turns on SSO that has already been configured"""
+  enable_payload = {
+    "ssoProvider":"SAML",
+    "loginPage":"STANDARD",
+    "ssoEnabled":True,
+    "ssoGroupsEnabled":False,
+    "ssoLoginDisabled":False
+  }
+
+  if disable_local:
+    enable_payload['loginPage'] = "SSO"
+  if groups_enabled:
+    enable_payload['ssoGroupsEnabled'] = True
+  if is_openid:
+    enable_payload['ssoProvider'] = "OIDC"
+
+  response = rh.cluster_post(cluster, "sso/ssoProvider", json=enable_payload)
+  return response.status_code
+
+def get_sso_status (cluster):
+  response = rh.cluster_get(cluster, "sso/ssoProvider")
+  return response.json()

dynatrace/cluster/config.py

@@ -0,0 +1,102 @@
+#!/bin/python3
+"""Cluster Group Operations"""
+import user_variables
+from dynatrace.requests import request_handler as rh
+from dynatrace.tenant import management_zones as mzh
+
+MZ_USER_PERMISSONS = {
+    "access_env": "VIEWER",
+    "change_settings": "MANAGE_SETTINGS",
+    "view_logs": "LOG_VIEWER",
+    "view_senstive": "VIEW_SENSITIVE_REQUEST_DATA"
+}
+
+def generate_group_name(template, user_type, tenant, app_name):
+  template = template.replace("{USER_TYPE}", user_type)
+  template = template.replace("{TENANT}", tenant)
+  template = template.replace("{APP_NAME}", app_name)
+  template = template.lower()
+  return template
+
+def create_app_groups(cluster, app_name):
+  """Create Dynatrace User Groups for Applications"""
+  role_types = user_variables.USER_GROUPS['role_types']
+  role_tenants = user_variables.USER_GROUPS['role_tenants']
+
+  all_new_groups = {}
+  for current_tenant in role_tenants:
+    all_new_groups[current_tenant] = {}
+    for current_type_key, current_type_value in role_types.items():
+      group_id = generate_group_name(user_variables.USER_GROUP_TEMPLATE, current_type_value, current_tenant, app_name)
+      current_group = {
+          "isClusterAdminGroup": False,
+          "name":group_id,
+          "ldapGroupNames": [
+              group_id,
+          ],
+          "accessRight": {}
+      }
+
+      response = rh.cluster_post(
+          cluster,
+          "groups",
+          json=current_group
+      )
+      all_new_groups[current_tenant][current_type_key] = ((response.json())['id'])
+  return all_new_groups
+
+def create_app_groups_setwide(app_name):
+  """Create Dynatrace User Groups for Applications"""
+  for cluster in user_variables.FULL_SET.values():
+    if cluster['is_managed']:
+      create_app_groups(cluster, app_name)
+
+def delete_app_groups (cluster, app_name):
+  role_types = user_variables.USER_GROUPS['role_types']
+  role_tenants = user_variables.USER_GROUPS['role_tenants']
+  
+  for current_tenant in role_tenants:
+    for current_type_value in role_types:
+      group_id = generate_group_name(user_variables.USER_GROUP_TEMPLATE, current_type_value, current_tenant, app_name)
+      group_id = ''.join(e for e in group_id if e.isalnum())
+      rh.cluster_delete(
+          cluster,
+          "groups/" + group_id
+      )
+  return
+
+def delete_app_groups_setwide(app_name):
+  """Create Dynatrace User Groups for Applications"""
+  for cluster in user_variables.FULL_SET.values():
+    if cluster['is_managed']:
+      delete_app_groups(cluster, app_name)
+
+def create_app_clusterwide(cluster, app_name, zones=None):
+  """Create App User Groups and Management Zones"""
+  # Create Standard App MZs
+  mz_list = {}
+  for tenant_key in cluster['tenant'].keys():
+    mzh.add_management_zone(
+        cluster,
+        tenant_key,
+        str.upper(app_name)
+    )
+    if tenant_key in zones:
+      mz_list[tenant_key] = []
+      for zone in zones[tenant_key]:
+        mz_id = mzh.add_management_zone(
+            cluster,
+            tenant_key,
+            str.upper(app_name),
+            zone
+        )
+        if mz_id is not None:
+          mz_list[tenant_key].append(mz_id)
+
+  # Create User Groups
+  user_groups = create_app_groups(cluster, app_name)
+  print(user_groups)
+
+  # for tenant in user_variables.USER_GROUPS['role_tenants']:
+  #   if "access_env" in user_groups [tenant]:
+  #     add_mz_to_user

dynatrace/cluster/ssl.py

@@ -0,0 +1,51 @@
+"""User Operations in Cluster Mangement"""
+import dynatrace.requests.request_handler as rh
+
+# TODO add check for is_managed
+
+def check_is_managed(cluster, ignore_saas):
+  """Checks if the cluster is Managed"""
+  if not cluster['is_managed'] and not ignore_saas:
+    raise Exception ('Cannot run operation on SaaS instances!')
+  return cluster['is_managed']
+
+def get_users(cluster, ignore_saas=True):
+  """Get the list of Users on the Cluster"""
+  check_is_managed(cluster, ignore_saas)
+  response = rh.cluster_get(cluster, "users")
+  return response.json()
+
+def add_user(cluster, user_json, ignore_saas=True):
+  """Add User to Cluster"""
+  check_is_managed(cluster, ignore_saas)
+  rh.cluster_post(cluster, "/users", json=user_json)
+  return 'OK'
+
+def update_user(cluster, user_json, ignore_saas=True):
+  """Update User to Cluster"""
+  check_is_managed(cluster, ignore_saas)
+  rh.cluster_put(cluster, "/users", json=user_json)
+  return 'OK'
+
+def get_user(cluster, user_id, ignore_saas=True):
+  """Get Details for a Single User"""
+  check_is_managed(cluster, ignore_saas)
+  response = rh.cluster_get(cluster, "users/" + user_id)
+  return response.json()
+
+def delete_user(cluster, user_id, ignore_saas=True):
+  """Delete a Single User"""
+  check_is_managed(cluster, ignore_saas)
+  response = rh.cluster_delete(cluster, "users/" + user_id)
+  return response.json()
+
+def get_user_count(cluster, ignore_saas=True):
+  """Return the number of, users in a cluster"""
+  check_is_managed(cluster, ignore_saas)
+  return len(get_users(cluster))
+
+def add_user_bulk(cluster, user_json, ignore_saas=True):
+  """Add Multiple Users"""
+  check_is_managed(cluster, ignore_saas)
+  rh.cluster_put(cluster, "/users/bulk", json=user_json)
+  return 'OK'