OpsLevel

https://docs.opslevel.com/docs/
Admin
OpsLevel is an internal developer portal that catalogs software services, enforces engineering...
Tokens:261,778
Snippets:2,158
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install OpsLevel CLI via Homebrew

Source: https://docs.opslevel.com/docs/api/cli

Installs the CLI using the Homebrew tap.

```bash
brew install opslevel/tap/cli
```

--------------------------------

### Install Preflight Utility

Source: https://docs.opslevel.com/docs/getting-started-with-self-hosted-opslevel

Installs the preflight utility from troubleshoot.sh, which is used to run preflight checks before helm install or helm upgrade. This is one way to install it; see the utility documentation for other ways.

```shell
curl https://krew.sh/preflight | bash
```

--------------------------------

### Example: Before/After GitHub Actions Workflow

Source: https://docs.opslevel.com/docs/creating-initiatives

Shows a before/after example for updating a GitHub Actions workflow. Use this to illustrate changes to YAML configuration.

```yaml
Update the GitHub Actions workflow:

Before:
- uses: actions/setup-node@v3
  with:
    node-version: '16'

After:
- uses: actions/setup-node@v4
  with:
    node-version: '20'
```

--------------------------------

### Install kubectl plugin with Homebrew

Source: https://docs.opslevel.com/docs/kubernetes-integration

Installs the kubectl plugin for the OpsLevel Kubernetes integration using Homebrew. Full installation instructions are available in the kubectl-opslevel repo.

```bash
brew install opslevel/tap/kubectl
```

--------------------------------

### Install OpsLevel Helm Chart

Source: https://docs.opslevel.com/docs/getting-started-with-self-hosted-opslevel

Installs the OpsLevel Helm chart into the opslevel namespace. The chart uses sane defaults that should work for every Kubernetes cluster.

```shell
helm install --namespace opslevel opslevel oci://registry.replicated.com/opslevel/helm/opslevel
```

--------------------------------

### Example repository opslevel.yml

Source: https://docs.opslevel.com/docs/api/opslevel-yml

Example opslevel.yml file for a repository. Sets the repository tier to tier_1, assigns the owner as order_management_team, and adds a tag with key version and value v1.0.0.

```yaml
---
version: 1
repository:
  tier: tier_1
  owner: order_management_team
  tags:
  - key: version
    value: v1.0.0

```

--------------------------------

### Example Query Variables for Database

Source: https://docs.opslevel.com/docs/import-infrastructure-objects-via-api

Example variables for the infrastructureResourceCreate mutation to create a Database object. Includes data fields like engine, endpoint, and storage_size, with providerData for GCP.

```json
{
  "data": {
    "name": "books-db-example",
    "external_id": "https://sqladmin.googleapis.com/sql/v1beta4/projects/genial-tangent-1234/instances/books-db-example",
    "zone": "us-central1",
    "engine": "mySQL",
    "engine_version": "8.0",
    "endpoint": "genial-tangent-1234:us-central1:books-db-example",
    "multi_zone_availability_enabled": true,
    "publicly_accessible": false,
    "port": 3306,
    "zone": "us-central1",
    "instance_type": "db-n1-standard-1",
    "storage_size": {
      "value": 200,
      "unit": "GB"
    },
    "storage_encrypted": true,
    "maintenance_window": "Monday",
    "creation_date": "2023-06-07T22:01:21.417000Z"
  },
  "schema": {"type": "Database"},
  "providerData": {
    "accountName": "5604422034290",
    "externalUrl": "https://console.cloud.google.com/home/dashboard?project=genial-tangent-1234",
    "providerName": "GCP"
  },
  "providerResourceType": "SQL"
}
```

--------------------------------

### Example Query Variables for VPC

Source: https://docs.opslevel.com/docs/import-infrastructure-objects-via-api

Example variables for the infrastructureResourceCreate mutation to create a Network (VPC) object. Includes data fields like subnets, is_default, and ipv4_cidr, with providerData for GCP.

```json
{
  "data": {
    "name": "gcp-vpc-5-example",
    "external_id": "https://www.googleapis.com/compute/v1/projects/genial-tangent-1234/global/networks/gcp-vpc-5-example",
    "zone": "global",
    "subnets": [],
    "is_default": true,
    "internet_gateway": "--",
    "dns_hostnames_enabled":false,
    "ipv4_cidr": "--",
    "nat_gateway": "--",
    "dns_support_enabled":false
  },
  "schema": {"type": "Network"},
  "providerData": {
    "accountName": "5604422034290",
    "externalUrl": "https://www.googleapis.com/compute/v1/projects/genial-tangent-1234",
    "providerName": "GCP"
  },
  "providerResourceType": "VPC network"
}
```

--------------------------------

### Example Query Variables for Compute

Source: https://docs.opslevel.com/docs/import-infrastructure-objects-via-api

Example variables for the infrastructureResourceCreate mutation to create a Compute object. Includes data fields like instance_id, zone, and instance_type, with providerData for GCP.

```json
{
  "data": {
    "name": "gke-autoscale-prod-1-example",
    "instance_id": "6412763931310739112",
    "external_id": "https://www.googleapis.com/compute/v1/projects/genial-tangent-1234/zones/us-central1-c/instances/gke-autoscale-prod-1-example",
    "image_id": "debian-11-bullseye-v20230615",
    "zone": "us-central1-c",
    "instance_type": "f1-micro",
    "platform_details": "Debian GNU/Linux",
    "launch_time": "2023-06-08T13:26:35.000000",
    "public_ip_address": "--"
  },
  "schema": {"type": "Compute"},
  "providerData": {
    "accountName": "5604422034290",
    "externalUrl": "https://www.googleapis.com/compute/v1/projects/genial-tangent-1234",
    "providerName": "GCP"
  },
  "providerResourceType": "Compute Engine"
}
```

--------------------------------

### Generate sample configuration

Source: https://docs.opslevel.com/docs/kubernetes-integration

Generates a sample configuration file showing various mapping examples.

```bash
kubectl opslevel config sample > ./opslevel-k8s.yaml
```

--------------------------------

### Create a deploy event with configuration file

Source: https://docs.opslevel.com/docs/api/cli

Creates a deploy event by piping a configuration file to the CLI, allowing for additional details like environment, description, and deployer information.

```bash
cat << EOF | opslevel create deploy -i "https://app.opslevel.com/integrations/deploy/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx"
service: "shopping_cart"
description: "Deployed by CI Pipeline: Deploy #234"
environment: "Production"
deploy-number: 234
deploy-url: https://heroku.deploys.com
dedup-id: 9ae54794-dfc5-4ac8-b1b5-78789f20f3f8
deployer:
  id: 1a9f841f-9a3d-4423-a05a-7e9c31a02b16
  name: Michael Scott
  email: mscott@example.com
EOF
```

--------------------------------

### Preview all services

Source: https://docs.opslevel.com/docs/kubernetes-integration

Specifying a sample count of 0 shows a preview of all services.

```bash
kubectl opslevel service preview 0 -c ./opslevel-k8s.yaml
```

--------------------------------

### Install OpsLevel agent with Helm

Source: https://docs.opslevel.com/docs/opslevel-agent

Helm command to install the OpsLevel agent using the values file.

```bash
helm install opslevel-agent opslevel/opslevel-agent -f values.yaml
```

--------------------------------

### Run kubectl opslevel commands

Source: https://docs.opslevel.com/docs/kubernetes-integration

After installing the kubectl-opslevel extension, place the binary in your $PATH and run kubectl opslevel commands.

```bash
kubectl opslevel ...
```

--------------------------------

### HTTP headers example

Source: https://docs.opslevel.com/docs/actions-walkthrough

Example of HTTP headers for authentication and content type. This pattern is common when authentication happens in the payload.

```json
{"authorization":"your-token-here","Accept":"application/vnd.github.everest-preview+json","content-type":"application/json"}
```

--------------------------------

### Environment variables for Snyk payload check example

Source: https://docs.opslevel.com/docs/payload-checks

Sets up required environment variables for the Snyk example: SNYK_TOKEN, SNYK_ORGANIZATION, OPSLEVEL_SERVICE_ALIAS, OPSLEVEL_CHECK_ID, and OPSLEVEL_PAYLOAD_URL_TOKEN.

```bash
SNYK_TOKEN=<Snyk API Token>
SNYK_ORGANIZATION=<Snyk Organization ID>
OPSLEVEL_SERVICE_ALIAS=<OpsLevel Service Alias>
OPSLEVEL_CHECK_ID=<OpsLevel Check ID>
OPSLEVEL_PAYLOAD_URL_TOKEN=<OpsLevel Payload URL Token>
```

--------------------------------

### Liquid filter example: generate 'filtrd txt'

Source: https://docs.opslevel.com/docs/checks/custom-event

Shows a basic Liquid filter usage to transform text. The example generates the string 'filtrd txt'.

```liquid
{{ 'txt' | append: ' filtrd' }}
```

--------------------------------

### Example: Edge Case for CODEOWNERS

Source: https://docs.opslevel.com/docs/creating-initiatives

Shows how to handle an edge case when adding a CODEOWNERS file. Mention exceptions or special handling to avoid overwriting existing content.

```text
Add a CODEOWNERS file with @platform-team as the default owner.

If a CODEOWNERS file already exists, add the default owner line only if it's not already present.
```

--------------------------------

### Example Jira Epic payload

Source: https://docs.opslevel.com/docs/mapping-integration-data-to-custom-properties

Example payload sent to the custom webhook endpoint for a Jira Epic. Contains the key, id, and an array of issues with status names.

```json
{
  "key": "APA-1123",
  "id": "10000000",
  "issues": [
    {
      "fields": {
        "status": {
          "name": "Open"
        }
      }
    },
    {
      "fields": {
        "status": {
          "name": "In Progress"
        }
      }
    }
  ]
}
```

--------------------------------

### Example Deploy Webhook Error Response

Source: https://docs.opslevel.com/docs/deploys

Shows the JSON structure of an error returned by a deploy webhook. The example indicates a 400 status with a missing 'description' parameter.

```json
{
  "errors": [
    {
      "status": 400,
      "title": "Description Error",
      "detail": "param is missing or the value is empty: description"
    }
  ]
}
```

--------------------------------

### Preview service mapping with API token

Source: https://docs.opslevel.com/docs/kubernetes-integration

Runs a dry-run preview of the mapping, sampling 5 services randomly. Requires the OpsLevel API token.

```bash
OL_APITOKEN=XXXX kubectl opslevel service preview -c ./opslevel-k8s.yaml
```

--------------------------------

### Example Bugsnag Organizations Response

Source: https://docs.opslevel.com/docs/bugsnag

Example JSON response from the Bugsnag API showing an organization object with an id field. Use the id values to integrate with OpsLevel.

```json
[
    {
        "id": "636d42b5ea946e0013f57627",
        "name": "Organization Name",
        ...
    }
]
```
Tokens:
Raw