Dashboard Pack - Octopus Deploy
This dashboard gives an overview of deployments and tasks from Octopus Deploy
High level view of all deployments
|Tasks (Grid)||High level view of all tasks|
How do I import and configure this dashboard?
Ensure you're using Dashboard Server v5.3 or above.
Create a Web API provider to connect with your Octopus Deploy environment.
Use the following settings:
Type Simple auth Name
Note: The name is case-sensitive and must be entered exactly like given here for the tiles to recognise the provider automatically. If you name it differently, you will need to select the provider manually for each tile on the dashboard.
Enter the base url for the Octopus API, i.e. https://octopus.company.com/api
Enter your Octopus Deploy API key in the following format:
First box (name):
x-Octopus-ApiKeySecond box (value):
Token( i.e. API-LKASJDLKAJDLKASLDKJ)How to create a Web API provider
In Dashboard Server navigate to the right-hand menu ☰ > system > Integrations
Under Integrations click on Web API and choose either Simple, Basic Auth or OAuth depending on the API you are using.About the different types of Integrations and Web API providers
No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).
Basic authentication. Your specified username and password will be Base64 encoded automatically.
Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorisation, and will require an OAuth provider to include the additional information about how to authorise against the service.
Note: When adding an OAuth provider you may get an message that the provider is not authorized if some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure Dashboard Server to use a proxy
Complete the provider fields, using your API provider's online documentation as a guide.
You are now ready to use this provider in a Web API tile (see How to use the Web API tile).
Download and import this dashboard pack.How to import a dashboard pack
Download the dashboard pack zip file for the dashboard pack you wish to import.
There may be additional steps before or after the import to get the dashboard working in your environment.
In Community Edition go to the top right hand menu ☰ > Import Dashboard Packs and drag the zip file into the Manual Import box.
The dashboard pack is imported and if the pack contains top-level dashboards, these will automatically appear in the navigation bar, usually in a folder called 'Community Dashboards' for dashboard packs from the SquaredUp Community.
Carry out any additional steps required to make the dashboard work in your environment. These steps will be described on the download page for each dashboard. For example, you may need to create the correctly named Web API provider, create a PowerShell profile, or edit tile scopes.
Edit the imported dashboard as required.