Skip to content

feat(orca-spe): Docs for Operational Analytics Plugin #2248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielGz wants to merge 7 commits into
base: master
Choose a base branch
from
Open

feat(orca-spe): Docs for Operational Analytics Plugin #2248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b493056
feat(orca-spe): included docs for SPE calculator Plugin
danielGz Dec 5, 2023
b856d9a
fixed reference path
danielGz Dec 5, 2023
5cdd9d1
fixed link title
danielGz Dec 5, 2023
6b4f04b
fixed a few things
danielGz Dec 5, 2023
78616f9
change plugin name to Armory Insights; merge files; add compat matrix
aimeeu Dec 7, 2023
69a0e06
rename to operational analytics plugin
aimeeu Dec 13, 2023
1b93690
fix error in plugin compat matrix
aimeeu Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions content/en/includes/plugins/plugin-compat-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
| Plugin | Spinnaker | Armory CD |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:----------------------------------:|
| [Armory CD-as-a-Service Plugin](https://developer.armory.io/docs/integrations/plugin-spinnaker)<br>The Armory Continuous Deployment-as-a-Service plugin enables performing canary and blue/green deployments in a single stage from Spinnaker to your Kubernetes deployment target using CD-as-a-Service. | 1.24+ | 2.24+<br>(included with Armory CD) |
| Plugin | Spinnaker | Armory CD |
|:-------|:--------:|:--------:|
| [Armory CD-as-a-Service Plugin](https://developer.armory.io/docs/integrations/plugin-spinnaker)<br>The Armory Continuous Deployment-as-a-Service plugin enables performing canary and blue/green deployments in a single stage from Spinnaker to your Kubernetes deployment target using CD-as-a-Service. | 1.24+ | 2.24+<br>(included with Armory CD)|
| {{< linkWithLinkTitle "plugins/aws-event-cache/_index.md" >}}<br>{{% getPageDesc "/plugins/aws-event-cache/_index.md" %}} | 1.28+ | 2.28+ |
| {{< linkWithLinkTitle "plugins/echo-event-filter.md" >}}<br>{{% getPageDesc "/plugins/echo-event-filter.md" %}} | 1.29+ | 2.30+ |
| {{< linkWithLinkTitle "plugins/github-integration/_index.md" >}}<br>{{% getPageDesc "/plugins/github-integration/_index.md" %}} | 1.30+ | 2.30+ |
| {{< linkWithLinkTitle "plugins/plugin-k8s-custom-resource-status.md" >}}<br>{{% getPageDesc "/plugins/plugin-k8s-custom-resource-status.md" %}} | 1.27+ | 2.27+ |
| {{< linkWithLinkTitle "plugins/pipelines-as-code/_index.md" >}}<br>{{% getPageDesc "/plugins/pipelines-as-code/_index.md" %}} | 1.26+ | 2.21+ |
| {{< linkWithLinkTitle "plugins/policy-engine/_index.md" >}}<br>{{% getPageDesc "/plugins/policy-engine/_index.md" %}} | 1.26+ | 2.26+ |
| {{< linkWithLinkTitle "plugins/scale-agent/_index.md" >}}<br>{{% getPageDesc "/plugins/scale-agent/_index.md" %}} | 1.26+ | 2.26+ |
| {{< linkWithLinkTitle "plugins/echo-event-filter.md" >}}<br>{{% getPageDesc "/plugins/echo-event-filter.md" %}} | 1.29+ | 2.30+ |
| {{< linkWithLinkTitle "plugins/github-integration/_index.md" >}}<br>{{% getPageDesc "/plugins/github-integration/_index.md" %}} | 1.30+ | 2.30+ |
| {{< linkWithLinkTitle "plugins/plugin-k8s-custom-resource-status.md" >}}<br>{{% getPageDesc "/plugins/plugin-k8s-custom-resource-status.md" %}} | 1.27+ | 2.27+ |
| {{< linkWithLinkTitle "plugins/operational-analytics/index.md" >}}<br>{{% getPageDesc "/plugins/operational-analytics/index.md" %}} | 1.28+ | 2.28+ |
| {{< linkWithLinkTitle "plugins/pipelines-as-code/_index.md" >}}<br>{{% getPageDesc "/plugins/pipelines-as-code/_index.md" %}} | 1.26+ | 2.21+ |
| {{< linkWithLinkTitle "plugins/policy-engine/_index.md" >}}<br>{{% getPageDesc "/plugins/policy-engine/_index.md" %}} | 1.26+ | 2.26+ |
| {{< linkWithLinkTitle "plugins/scale-agent/_index.md" >}}<br>{{% getPageDesc "/plugins/scale-agent/_index.md" %}} | 1.26+ | 2.26+ |
| {{< linkWithLinkTitle "plugins/self-serve-error-management.md" >}}<br>{{% getPageDesc "/plugins/self-serve-error-management.md" %}} | 1.29+ | 2.30+ |
| {{< linkWithLinkTitle "plugins/terraform/_index.md" >}}<br>{{% getPageDesc "/plugins/terraform/_index.md" %}} | 1.26+ | 2.26+ |
| {{< linkWithLinkTitle "plugins/terraform/_index.md" >}}<br>{{% getPageDesc "/plugins/terraform/_index.md" %}} | 1.26+ | 2.26+ |
301 changes: 301 additions & 0 deletions content/en/plugins/operational-analytics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,301 @@
---
title: Operational Analytics Plugin for Spinnaker
linkTitle: Operational Analytics
description: >
The Operational Analytics Plugin for Spinnaker and Armory Continuous Deployment automates the aggregation of successful pipeline count by day and makes the information available to query and visualize through an API.
no_list: true
---

![Proprietary](/images/proprietary.svg) [![Generally available](/images/ga.svg)]({{< ref "release-definitions#ga" >}})

## What the Operational Analytics plugin does

Armory’s Operational Analytics plugin for Spinnaker and Armory CD adds functionality to Orca that enables the storage of new metrics in Orca. You can retrieve those metrics using the API. The plugin is designed to provide key performance indicators without adding more services or operational overhead to the Spinnaker cluster to which it is installed.

{{< figure src="operational-analytics-architecture" height="80%" width=80%" >}}

## {{% heading "prereq" %}}

* Your Orca service must use a SQL backend. See [Orca configured with SQL backend]({{< ref "continuous-deployment/armory-admin/orca-sql-configure" >}}) for instructions.
* You're able to call Orca's service endpoint (by default `http://spin-orca:8083`)

## Compatibility matrix

| Armory CD Version | Spinnaker Version | Armory Insights Plugin Version |
|-------------------|-----------------------------| ------------------- |
| 2.31.x | 1.31.x | 1.0.0 |
| 2.30.x | 1.29.x, 1.30.x | 1.0.0 |
| 2.28.x | 1.28.x | 1.0.0 |

## Install the plugin

{{< tabpane text=true right=true >}}

{{% tab header="**Install Method**:" disabled=true /%}}


{{% tab header="Armory Operator" %}}

1. In your `spinnaker-kustomize-patches/plugins` directory, create an `operational-analytics-plugin.yml` file with the following contents:

```yaml
apiVersion: spinnaker.armory.io/v1alpha2
kind: SpinnakerService
metadata:
name: spinnaker
spec:
spinnakerConfig:
profiles:
spinnaker:
insights:
jobs:
pipelineStatusCount:
cron: '1 1 1 * * *'
spinnaker:
extensibility:
repositories:
repository:
enabled: true
url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json
orca:
spinnaker:
extensibility:
plugins:
Armory.Insights:
version: <version>
enabled: true
extensions:
armory.insights:
enabled: true
```

- `version`: Replace `<version>` with the plugin version compatible with your Spinnaker version.
- `insights.jobs.pipelineStatusCount.cron`: Replace with a cron expression that corresponds to the time of the day with lowest load. You can disable this field by using `-` as the expression. For example:

```yaml
spec:
spinnakerConfig:
profiles:
spinnaker:
insights:
jobs:
pipelineStatusCount:
cron: '-'
```


1. Add the plugin patch to your Kustomize recipe's `patchesStrategicMerge` section. For example:

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namespace: spinnaker

components:
- core/base
- core/persistence/in-cluster
- targets/kubernetes/default

patchesStrategicMerge:
- core/patches/oss-version.yml
- plugins/operational-analytics-plugin.yml

patches:
- target:
kind: SpinnakerService
path: utilities/switch-to-oss.yml
```

1. Apply the updates to your Kustomization recipe.

```bash
kubectl apply -k <kustomization-directory-path>
```

{{% /tab %}}


{{% tab header="Spinnaker Operator" %}}

1. In your `spinnaker-kustomize-patches/plugins/oss` directory, create an `operational-analytics-plugin.yml` file with the following contents:

```yaml
apiVersion: spinnaker.io/v1alpha2
kind: SpinnakerService
metadata:
name: spinnaker
spec:
spinnakerConfig:
profiles:
spinnaker:
insights:
jobs:
pipelineStatusCount:
cron: '1 1 1 * * *'
spinnaker:
extensibility:
repositories:
repository:
enabled: true
url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json
orca:
spinnaker:
extensibility:
plugins:
Armory.Insights:
version: <version>
enabled: true
extensions:
armory.insights:
enabled: true
```

- `version`: Replace `<version>` with the plugin version compatible with your Spinnaker version.
- `insights.jobs.pipelineStatusCount.cron`: Replace with a cron expression that corresponds to the time of the day with lowest load. You can disable this field by using `-` as the expression. For example:

```yaml
spec:
spinnakerConfig:
profiles:
spinnaker:
insights:
jobs:
pipelineStatusCount:
cron: '-'
```


1. Add the plugin patch to your Kustomize recipe's `patchesStrategicMerge` section.

For example:

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namespace: spinnaker

components:
- core/base
- core/persistence/in-cluster
- targets/kubernetes/default

patchesStrategicMerge:
- core/patches/oss-version.yml
- plugins/oss/operational-analytics-plugin.yml

patches:
- target:
kind: SpinnakerService
path: utilities/switch-to-oss.yml
```

1. Apply the updates to your Kustomization recipe.

```bash
kubectl apply -k <kustomization-directory-path>
```

{{% /tab %}}


{{% tab header="Spinnaker Halyard" %}}

The Operational Analytics plugin extends Orca. You should create or update the extended service’s local profile in the same directory as the other Halyard configuration files. This is usually `~/.hal/default/profiles` on the machine where Halyard is running.

```yaml
insights:
jobs:
pipelineStatusCount:
cron: '1 1 1 * * *'

spinnaker:
extensibility:
plugins:
Armory.Insights:
version: <version>
enabled: true
extensions:
armory.insights:
enabled: true
repositories:
repository:
enabled: true
url: https://raw.githubusercontent.com/armory-plugins/pluginRepository/master/repositories.json
```

- `version`: Replace `<version>` with the plugin version compatible with your Spinnaker version.
- `insights.jobs.pipelineStatusCount.cron`: Replace with a cron expression that corresponds to the time of the day with lowest load. You can disable this field by using `-` as the expression. For example:

```yaml
insights:
jobs:
pipelineStatusCount:
cron: '-'
```

Save your file and apply your changes by running `hal deploy apply`.

{{% /tab %}}

{{< /tabpane >}}

## How to use the plugin

### API endpoint

`/insights/pipelines/statuses/count`

| Parameter | Type | Description | Optional | Default Value |
|-----------|-----------------------|----------------------------------|----------|---------------|
| from | Date (yyyy-MM-dd) | Starting Date | Yes | 30 days ago |
| to | Date (yyyy-MM-dd) | End Date | Yes | Today |
| limit | Number | Max Number of results | Yes | 1000 |
| offsetId | Number | Starting Id (Exclusive) | Yes | nil |
| descOrder | Boolean | Sort results in descending order | Yes | false |
| status | SUCCEEDED \| TERMINAL | Status of the aggregate | Yes | SUCCEEDED |

### JSON Response

```json
{
"records": [
{
"id": [id],
"status": "[status]",
"date": [UNIX milliseconds],
"count": [count],
"day": "yyyy-MM-dd"
},
...
],
"limit": [limit],
"count": [count],
"from": "yyyy-MM-dd",
"to": "yyyy-MM-dd"
}
```

#### Root object

| Field | Type | Description |
|---------|--------|--------------------------------------|
| records | Array | Array of record objects |
| limit | Number | Limit on the number of records |
| count | Number | Total number of records |
| from | String | Start date for the record collection |
| to | String | End date for the record collection |

#### Record object

Each object in the `records` array has the following structure:

| Field | Type | Description |
|--------|--------|---------------------------------------------------------|
| id | Number | Unique identifier of the record |
| status | String | Status of the record (e.g., "SUCCEEDED") |
| date | Number | Date of the record in milliseconds since epoch |
| count | Number | Count associated with the record |
| day | String | The day corresponding to the record (yyyy-MM-dd format) |

Binary file added content/en/plugins/operational-analytics/operational-analytics-architecture.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.