octoreport

command module

v0.0.0-...-f88b001 Latest Latest Go to latest Published: Jan 19, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Octopus Report runs audit reports against an Octopus Deploy server.

The Octopus REST API has breaking changes starting with 4.x, so this program only works with 3.x.

go build -o octoreport.exe main.go
octoreport.exe

You need to specify the Octopus server to query, either in a config.yml file, in environment variables, or in command line parameters.

config.yml

octopus:
   address: https://samples.octopus.app
   apikey: API-GUEST

octoreport

environment variables

export OCTOPUS_ADDRESS=https://samples.octopus.app
export OCTOPUS_APIKEY=API-GUEST
octoreport

command line parameters

octoreport octopus.address=https://samples.octopus.app octopus.apikey=API-GUEST

export LOG_LEVEL=Debug

octoreport -help

Option	Description
-help	display usage of this program
-info	display information about this program
-config	display program configuration that was loaded
-server	display the Octopus server version information
-appsec	display a CSV format report of users, teams, environments, roles
-report	display a report of all teams and their users/roles/environments/project groups/projects
-teams	display all teams
-users	display all users
-roles	display all user roles
-environments	display all environments
-projects	display all projects
-projectgroups	display all project groups
-tenants	display all tenants
-channels	display all channels
-feeds	display all feeds
-lifecycles	display all lifecycles
-machines	display all machines
-machineroles	display all machineroles