Skip to content

Commit

Permalink
Merge pull request #149 from sassoftware/develop
Browse files Browse the repository at this point in the history
Merge develop branch in preparation for release 1.5.0
  • Loading branch information
kevinlinglesas authored Sep 29, 2021
2 parents eac1dea + a466370 commit 299223a
Show file tree
Hide file tree
Showing 82 changed files with 4,676 additions and 3,130 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Each tool that is included in the resource kit provides a readme that describes
SAS Viya ARK tools require third-party packages be installed before use. All required packages can be installed using the provided `requirements.txt`:

```commandline
$ python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements.txt
```
The Python packages are only required on the host where SAS Viya ARK tools are executed.

Expand Down
14 changes: 7 additions & 7 deletions deployment_report/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ included in the report. Otherwise, un-retrievable information is omitted.
SAS Viya ARK tools require third-party packages be installed before use. All required packages can be installed using the provided `requirements.txt`:

```commandline
$ python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements.txt
```

Download the latest version of this tool and update required packages with every new software order.
Expand All @@ -35,7 +35,7 @@ deployment can be specified by including the `-n` or `--namespace` option.
deployment.

```commandline
$ python3 viya-ark.py deployment-report --namespace sas
python3 viya-ark.py deployment-report --namespace sas
```

### Including Log Snippets for All Pods
Expand All @@ -47,7 +47,7 @@ Using this option increases the runtime of the command as well as the size of th
deployment.

```commandline
$ python3 viya-ark.py deployment-report -n sas --include-pod-log-snips
python3 viya-ark.py deployment-report -n sas --include-pod-log-snips
```

### Including Resource Definitions for All Resources
Expand All @@ -59,7 +59,7 @@ definitions for all resources found in the deployment. Using this option increas
deployment.

```commandline
$ python3 viya-ark.py deployment-report -n sas --include-resource-definitions
python3 viya-ark.py deployment-report -n sas --include-resource-definitions
```

### Creating the Data File Only
Expand All @@ -71,7 +71,7 @@ is omitted.
deployment.

```commandline
$ python3 viya-ark.py deployment-report -n sas --data-file-only
python3 viya-ark.py deployment-report -n sas --data-file-only
```

### Redirecting Output
Expand All @@ -84,15 +84,15 @@ any file names.
deployment.

```commandline
$ python3 viya-ark.py deployment-report -n sas --output-dir="/path/to/report/"
python3 viya-ark.py deployment-report -n sas --output-dir="/path/to/report/"
```

### Help with the Command

The `-h` or `--help` option can be used to view usage information and list all options available for the report.

```commandline
$ python3 viya-ark.py deployment-report --help
python3 viya-ark.py deployment-report --help
```

## Report Output
Expand Down
28 changes: 21 additions & 7 deletions deployment_report/model/static/viya_deployment_report_keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@ class ViyaDeploymentReportKeys(object):
SAS_COMPONENTS_DICT = "sasComponents"
UNAVAILABLE_RESOURCES_LIST = "_unavailableResources"

class KindDetails(object):
class ResourceTypeDetails(object):
"""
Class defining static references to keys in kind detail dictionaries in resulting ViyaDeploymentReport data
structure.
Class defining static references to keys in resource type details dictionaries in resulting
ViyaDeploymentReport data structure.
"""
AVAILABLE = "available"
COUNT = "count"
KIND = "kind"
SAS_CRD = "sasCRD"

class Kubernetes(object):
Expand All @@ -45,15 +46,15 @@ class Kubernetes(object):
API_VERSIONS_LIST = "apiVersions"
CADENCE_INFO = "cadenceInfo"
DB_INFO = "dbInfo"
DISCOVERED_KINDS_DICT = "discoveredKinds"
DISCOVERED_RESOURCE_TYPES_DICT = "discoveredResourceTypes"
INGRESS_CTRL = "ingressController"
NAMESPACE = "namespace"
NODES_DICT = "nodes"
VERSIONS_DICT = "versions"

class ResourceDetails(object):
"""
Class defining static references to keys in resource detail dictionaries in the resulting ViyaDeploymentReport
Class defining static references to keys in resource details dictionaries in the resulting ViyaDeploymentReport
data structure.
"""
EXT_DICT = "ext"
Expand All @@ -68,11 +69,24 @@ class Ext(object):
LOG_SNIP_LIST = "logSnip"
METRICS_DICT = "metrics"
RELATIONSHIPS_LIST = "relationships"
RESOURCE_TYPE = "resourceType"

class Relationship(object):
"""
Class defining static references to keys in resource's ext.relationships list in the resulting
ViyaDeploymentReport data structure.
"""
KIND = "kind"
NAME = "name"
RESOURCE_NAME = "resourceName"
RESOURCE_TYPE = "resourceType"

class DatabaseDetails(object):
"""
Class defining static references to keys in Database details dictionaries in resulting
ViyaDeploymentReport data structure.
"""
DBHOST = "host"
DBNAME = "name"
DBPORT = "port"
DBTYPE = "type"
DBSSL = "sslEnabled"
DBCONN = "connection"
Loading

0 comments on commit 299223a

Please sign in to comment.