Categorygithub.com/paradocs-cli/generatedocs
modulepackage
1.0.0
Repository: https://github.com/paradocs-cli/generatedocs.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
GetAwsState takes inputs of type StateProviders, and utilizes the AWS Go SDK to download state file from s3 buckets and then remove the state file once complete.
GetAzState takes inputs including storage account name, container name, blob name, and SAS token to download a blob(tfstate file) for use later on.
GetData takes a slice of sting and creates JSON objects from data retrieved such as variables, resources, modules, etc.
GetDirData iterates through directories and returns data about each directory.
GetDirs takes a string argument and returns a slice of string of directories that containt terraform files.
GetFileInfo iterates through files and returns data about each file.
GetGcpState takes inputs of type StateProviders, and utilizes the Google Cloud Go SDK to download state file from s3 buckets and then remove the state file once complete.
GetTfcState takes a TFC api token as well as the workspace name and organization name and returns the current version of the state file.
ManipulateTfcState takes an argument of TfcState and returns cloud state by doing a GET request on the hosted state download url object.
WhichCloudState uses a case statement to evaluate providers and pull in remote terraform state from the appropriate location.
WriteMarkdownCloudState generates a README which recursively documents all terraform state resources from the specified backendWriteMarkdownCloudState does template execution to write the file.
WriteMarkdownRepo generates a README which recursively documents statistics about the repo from the root downWriteMarkdownRepo does template execution to write the file.
WriteMarkdownTerra generates a README which recursively documents all terraform codeWriteMarkdownTerra does template execution to write the file.
WriteMarkdownTfcState generates a README which recursively documents all terraform state resources from the specified backendWriteMarkdownTfcState does template execution to write the file.

# Constants

RepoDocGeneric is a template for generating repository documentation.
TerraDocGeneric is a template for generating terraform documentation.
TerraStateDocCloud is a template for generating terraform documentation.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author