PerfectScale

https://docs.perfectscale.io/
Admin
PerfectScale is a Kubernetes optimization platform that automatically analyzes and optimizes...
Tokens:89,121
Snippets:1,190
Trust Score:8.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example GET Request for Dynamic Documentation Query

Source: https://docs.perfectscale.io/customize-workflow/ticketing-and-bug-tracking

Use this GET request format to query the documentation dynamically with a specific question.

```http
GET https://docs.perfectscale.io/customize-workflow/ticketing-and-bug-tracking.md?ask=<question>
```

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

### Dynamic Documentation Query Example

Source: https://docs.perfectscale.io/enable-automation/configuring-automation-with-crd/including-a-cluster-namespace-or-workload-to-the-automation/configuring-automation-for-a-namespace-with-crd

Perform an HTTP GET request to the current page URL with the `ask` query parameter to ask a question. The question should be specific and self-contained. The response will contain a direct answer and relevant excerpts.

```bash
GET https://docs.perfectscale.io/enable-automation/configuring-automation-with-crd/including-a-cluster-namespace-or-workload-to-the-automation/configuring-automation-for-a-namespace-with-crd.md?ask=<question>
```

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

### Example kubectl Output for Node CPU Capacity

Source: https://docs.perfectscale.io/perfectscale-trial/perfectscale-trial/how-to-find-your-allocated-vcpu

This is an example output from the `kubectl get nodes` command, showing the name of each node and its CPU core capacity.

```text
NAME                                             CORES
ip-10-107-0-11.eu-central-1.compute.internal     2
ip-10-107-12-213.eu-central-1.compute.internal   2
ip-10-107-24-124.eu-central-1.compute.internal   8
ip-10-107-24-142.eu-central-1.compute.internal   2
ip-10-107-26-193.eu-central-1.compute.internal   2
ip-10-107-31-30.eu-central-1.compute.internal    8
ip-10-107-32-253.eu-central-1.compute.internal   4
ip-10-107-32-47.eu-central-1.compute.internal    4
ip-10-107-37-121.eu-central-1.compute.internal   2
ip-10-107-4-114.eu-central-1.compute.internal    2
ip-10-107-40-28.eu-central-1.compute.internal    4
ip-10-107-45-210.eu-central-1.compute.internal   2
ip-10-107-47-136.eu-central-1.compute.internal   2
ip-10-107-47-184.eu-central-1.compute.internal   4
ip-10-107-7-175.eu-central-1.compute.internal    4
ip-10-107-7-204.eu-central-1.compute.internal    2
```

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

### Query Documentation via HTTP GET Request

Source: https://docs.perfectscale.io/enable-automation/automation-with-gitops

Perform an HTTP GET request with the `ask` query parameter to dynamically query the documentation for specific information or clarification.

```http
GET https://docs.perfectscale.io/enable-automation/automation-with-gitops.md?ask=<question>
```

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

### Querying Documentation via HTTP GET

Source: https://docs.perfectscale.io/enable-automation/configuring-automation-via-ui

Use this HTTP GET request format to query the documentation dynamically. Replace `<question>` with your specific query.

```http
GET https://docs.perfectscale.io/enable-automation/configuring-automation-via-ui.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.perfectscale.io/visibility-and-optimization/java-containers

Perform an HTTP GET request to the documentation URL with the `ask` query parameter to get dynamic answers to specific questions. The response includes direct answers and relevant excerpts.

```http
GET https://docs.perfectscale.io/visibility-and-optimization/java-containers.md?ask=<question>
```

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

### Quick Install: Prom-Exporter with Prometheus Operator, Alerts, and Grafana

Source: https://docs.perfectscale.io/administration/perfectscale-prometheus-exporter

Install the Prom-Exporter with Prometheus Operator integration, enabling ServiceMonitor, Prometheus rules for alerts, and Grafana dashboards. This is a convenient way to get started with full monitoring capabilities.

```bash
helm upgrade --install --namespace perfectscale psc-prom-exporter \
--set scrapers.serviceMonitor.enabled=true \
--set alerts.prometheusRule.enabled=true \
--set dashbords.grafana.enabled=true \
perfectscale/psc-prom-exporter
```

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

### Query Documentation with GET Request

Source: https://docs.perfectscale.io/customize-workflow/pricing/azure-cost-management-configuration

Perform an HTTP GET request to a documentation URL with the 'ask' query parameter to dynamically query the documentation. Use this for questions not explicitly answered on the page or for clarification.

```HTTP
GET https://docs.perfectscale.io/customize-workflow/pricing/azure-cost-management-configuration.md?ask=<question>
```

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

### Example Cluster Automation Config with Mixed Label Selectors

Source: https://docs.perfectscale.io/enable-automation/configuring-automation-with-crd/including-a-cluster-namespace-or-workload-to-the-automation/configuring-automation-for-a-workload-with-crd

This example demonstrates a `ClusterAutomationConfig` with a mix of `allowAutomation: false` and `allowAutomation: true` settings for `workloadLabelSelectors`. Automation will apply to workloads matching `allowAutomation: true` labels and not matching `allowAutomation: false` labels.

```yaml
apiVersion: perfectscale.io/v1
kind: ClusterAutomationConfig
metadata:
  name: your-cluster-automation-config
spec:
  automation:
    operational:
      automationMode: "Enabled" # Enables automation for the workloads with a specific type in the cluster/namespace
      workloadLabelSelectors:
        - key: "environment"
          value: "production"
          allowAutomation: false    # Disables Automation for workload with the specified label
        - key: "env"
          value: "dev"
          allowAutomation: true    # Enables Automation for workload with the specified label
        - key: "tier"
          value: "frontend"
          allowAutomation: true     # Enables Automation for workload with the specified label
```

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

### Querying Documentation via HTTP GET

Source: https://docs.perfectscale.io/enable-automation/configuring-automation-with-crd/including-a-cluster-namespace-or-workload-to-the-automation

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. Use this for clarification or to retrieve related information not explicitly on the page.

```bash
GET https://docs.perfectscale.io/enable-automation/configuring-automation-with-crd/including-a-cluster-namespace-or-workload-to-the-automation.md?ask=<question>
```

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

### Install PerfectScale Prometheus Exporter

Source: https://docs.perfectscale.io/administration/perfectscale-prometheus-exporter

Install the PerfectScale Prometheus exporter chart. Ensure it is installed in the same namespace as the PerfectScale Agent to reuse existing credentials.

```bash
helm upgrade --install --namespace perfectscale psc-prom-exporter perfectscale/psc-prom-exporter
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/visibility-and-optimization/trends-monitoring

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and self-contained.

```http
GET https://docs.perfectscale.io/visibility-and-optimization/trends-monitoring.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/customize-workflow/customization-overview

Perform an HTTP GET request to query the documentation dynamically. Append the 'ask' query parameter with your question in natural language to retrieve specific information or clarifications.

```http
GET https://docs.perfectscale.io/customize-workflow/customization-overview.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/enable-automation

Perform an HTTP GET request on the current page URL with the `ask` query parameter to ask a question. The question should be specific and self-contained. Use this when the answer is not explicitly present, or you need clarification or additional context.

```http
GET https://docs.perfectscale.io/enable-automation.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/configure-alerts/resiliency-alerts

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to ask a question. The question should be specific and self-contained. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.perfectscale.io/configure-alerts/resiliency-alerts.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/customize-workflow/pricing

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this for specific questions, clarifications, or to retrieve related documentation sections.

```HTTP
GET https://docs.perfectscale.io/customize-workflow/pricing.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/cloud-billing-integration/connecting-aws-cur

Perform an HTTP GET request to the current page URL, appending your question as the 'ask' query parameter to retrieve specific information dynamically.

```HTTP
GET https://docs.perfectscale.io/cloud-billing-integration/connecting-aws-cur.md?ask=<question>
```

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

### Quick Install: Prom-Exporter with DataDog and DataDog Alerts

Source: https://docs.perfectscale.io/administration/perfectscale-prometheus-exporter

Install the Prom-Exporter with DataDog integration, enabling DataDog scrapers and DataDog alerts. This configuration is suitable for users who leverage DataDog for their monitoring and alerting needs.

```bash
helm upgrade --install --namespace perfectscale psc-prom-exporter \
--set scrapers.datadog.enabled=true \
--set alerts.datadogMonitor.enabled=true \
perfectscale/psc-prom-exporter
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/customize-workflow/communication-and-messaging/datadog-alerts-integration

Perform an HTTP GET request to a documentation URL with the `ask` query parameter to retrieve specific information dynamically. The question should be self-contained and in natural language.

```http
GET https://docs.perfectscale.io/customize-workflow/communication-and-messaging/datadog-alerts-integration.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/visibility-and-optimization/clusters-metrics-overview

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific, self-contained natural language question. The response will contain a direct answer and relevant excerpts from the documentation.

```http
GET https://docs.perfectscale.io/visibility-and-optimization/clusters-metrics-overview.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/administration/security/agent-rbac-permissions

You can dynamically query this documentation page by making an HTTP GET request with the `ask` query parameter. This is useful for retrieving specific information, clarifications, or related documentation sections not explicitly present on the page.

```http
GET https://docs.perfectscale.io/administration/security/agent-rbac-permissions.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/administration/help-center

Perform an HTTP GET request to a documentation URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and in natural language. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```HTTP
GET https://docs.perfectscale.io/administration/help-center.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/customize-workflow/communication-and-messaging

Use this method to dynamically query the documentation. Perform an HTTP GET request on the current page URL with the 'ask' query parameter, providing a specific, self-contained question in natural language.

```http
GET https://docs.perfectscale.io/customize-workflow/communication-and-messaging.md?ask=<question>
```

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

### Azure Billing Profile Configuration Example

Source: https://docs.perfectscale.io/cloud-billing-integration/connecting-azure-cost-management

This YAML configuration demonstrates how to set up your Azure Billing profile, including optional global discounts and authentication details. Ensure all required IDs are correctly provided.

```yaml
global_discount:
  percentage: 15
  start_date: 2025-12-31
azure_auth_type: workload_identity
azure_client_id: ata4ed50-0d03-4752-g6r7-b4bbc5h32e8u
azure_subscription_id: df2d6148-6bdc-4a65-a0b0-3fa54678bb04
azure_tenant_id: c8aed8ae-6a60-4f42-a6bh-aee92bf2e432
```

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

### AWS CUR Profile Configuration with Global Discount

Source: https://docs.perfectscale.io/cloud-billing-integration/connecting-aws-cur

Configure your AWS CUR profile to include a global discount percentage and start date. This example shows how to set a 15% discount starting from December 31, 2025, alongside other necessary Athena and AWS account details.

```yaml
global_discount:
  percentage: 15
  start_sate: 2025-31-12
athena_database: athenacurcfn_access-perfectscale-account-to-cur
athena_region: us-east-1
athena_result_bucket: s3://access-perfectscale-account-to-cur/
athena_table: access-perfectscale-account-to-cur
aws_account_id: '888061904880'
aws_external_id: f47ac10b-58cc-4372-a567-0e02b2c3d479
role_arn: arn:aws:iam::693587426073:role/access-perfectscale-account-to-cur
```

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

### GCP Billing Profile Configuration Example

Source: https://docs.perfectscale.io/cloud-billing-integration/connecting-gcp-cloud-billing

This YAML configuration defines the parameters for integrating with GCP Cloud Billing, including project ID, billing account, service account, dataset ID, and an optional global discount with its start date.

```yaml
global_discount:
  percentage: 15
  start_date: 2025-12-31
gcp_billing_account: 02DC4B_6001C0_B6C05B
gcp_dataset_id: with_random_name_us
gcp_project_id: test-4-000004
gcp_service_account: for-ps-access@test-4-000004.iam.gserviceaccount.com
```

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

### Combine UI and Inline Profiles in ClusterSettings CR

Source: https://docs.perfectscale.io/customize-workflow/customization-overview

Use this example to configure a `ClusterSettings` CR that includes both inline profiles (like custom pricing and Slack integrations) and references to UI-created profiles (like Jira and podfit labels) using `refByID`. This allows for flexible management of different profile types within a single resource.

```yaml
apiVersion: perfectscale.io/v1
kind: ClusterSettings
metadata:
  name: cluster-settings-main
  namespace: perfectscale
spec:
  profiles:
    # Pricing: Create inline custom pricing profile and assign it
    pricing:
      - type: custom
        name: production-pricing
        assigned: true
        value:
          nodeTypes:
            - instanceType: c5.large
              pricing:
                cpuCoreHourPrice: 0.085
                memGBHourPrice: 0.0095
            - instanceType: c5.xlarge
              pricing:
                cpuCoreHourPrice: 0.085
                memGBHourPrice: 0.0095
            - instanceType: m5.large
              pricing:
                cpuCoreHourPrice: 0.096
                memGBHourPrice: 0.0096

      # Create AWS CUR profile but don't assign it yet (for testing)
      - type: aws_cur
        name: aws-cur-backup
        assigned: false
        value:
          role_arn: "arn:aws:iam::your-account-id:role/your-role-name"
          aws_external_id: "your-unique-external-id-here"
          athena_database: athenacurcfn_perfectscale_cur
          athena_region: us-east-1
          athena_result_bucket: s3://perfectscale-cur-results/
          athena_table: perfectscale_cur_hourly
          aws_account_id: "your-aws-account-id-here"

    # Integrations: Mix inline Slack and referenced Jira
    integrations:
      # Create and assign inline Slack integration
      - type: slack
        name: team-alerts
        assigned: true
        value:
          channel: "perfectscale-production"
          routings:
            - label_alert
            - cost_waste_alert
          slack_token_from:
            secretKeyRef:
              name: slack-credentials
              key: bot-token

      # Reference existing Jira integration (created in UI)
      - type: jira
        refByID: "jira-1"

    # Resiliency Alerts: Create inline profile
    resiliency_alerts:
      - name: production-alerts
        assigned: true
        value:
          min_risk_level: high
          ignore_workload: "^(test-.*|dev-.*)"
          ignore_namespace: "^(kube-system|kube-public)$"
          ignore_container: "^(istio-proxy|envoy)$"
          ignore_indicator: ""

    # PodFit Labels: Reference existing profile
    podfit_labels:
      - refByID: "label-1"

    # Customization: Create inline profile
    customization:
      - name: app-labels
        assigned: true
        value:
          workload_labels:
            - app.kubernetes.io/name
            - app.kubernetes.io/component
            - team
            - cost-center
          node:
            spot_labels:
              label_cloud_google_com_gke_nodepool: pool-2
              label_spotinst_io_node_lifecycle: spot
            node_group_labels:
              - eks.amazonaws.com/nodegroup
              - kops.k8s.io/instancegroup
            architecture_labels:
              - kubernetes.io/arch
            os_labels:
              - kubernetes.io/os
            instance_type_labels:
              - node.kubernetes.io/instance-type
            region_labels:
              - topology.kubernetes.io/region
            availability_zone_labels:
              - topology.kubernetes.io/zone
          ignored_pod_labels:
            - uid
            - namespace
          ignored_node_labels:
            - uid

```

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

### Install CRDs for ClusterSettings

Source: https://docs.perfectscale.io/customize-workflow/customization-overview

Manually install the `ClusterSettings` CRDs if they are not automatically installed during a `helm upgrade`. This is required for managing cluster settings using custom resources.

```bash
kubectl apply -f https://github.com/perfectscale-io/perfectscale-io.github.io/blob/main/charts/perfectscale-agent/crds/clustersettings.yaml
```

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

### Perform HTTP GET Request with 'ask' Parameter

Source: https://docs.perfectscale.io/product-overview/system-and-user-defined-restrictions

Use this method to query the documentation dynamically. The 'ask' parameter should contain a specific, self-contained question in natural language. The response will include a direct answer and relevant documentation excerpts.

```HTTP
GET https://docs.perfectscale.io/product-overview/system-and-user-defined-restrictions.md?ask=<question>
```

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

### Verify PerfectScale Automation Agent Installation

Source: https://docs.perfectscale.io/enable-automation/automation-setup-instructions

Tests the installation of the PerfectScale Automation Agent and displays logs to confirm it is running correctly. Use this command after installation to ensure the agent is operational.

```bash
helm test psc-autoscaler -n perfectscale --logs
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/cloud-billing-integration/configuring-multi-cloud-billing-integration

To get additional information not directly present on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.perfectscale.io/cloud-billing-integration/configuring-multi-cloud-billing-integration.md?ask=<question>
```

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

### Query Documentation with 'ask' Parameter

Source: https://docs.perfectscale.io/perfectscale-trial/perfectscale-trial

Use this GET request to query the documentation dynamically with a specific question. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.perfectscale.io/perfectscale-trial/perfectscale-trial.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.perfectscale.io/administration/security

To get additional information not directly present, perform an HTTP GET request on the current page URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.perfectscale.io/administration/security.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.perfectscale.io/cloud-billing-integration/about-cloud-billing-integration

Perform an HTTP GET request to query the documentation dynamically using the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.perfectscale.io/cloud-billing-integration/about-cloud-billing-integration.md?ask=<question>
```

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

### OpenAPI Specification for GET /clusters

Source: https://docs.perfectscale.io/api/public-api

This OpenAPI 3.0 specification defines the GET /clusters endpoint, which retrieves a list of clusters. It includes details about the request, responses, and data schemas.

```json
{
"openapi":"3.0.3",
"info":{"title":"Perfectscale API - OpenAPI 3.0","version":"v1"},
"servers":[{"url":"https://api.app.perfectscale.io/public/v1"}],
"security":[{"auth":[]}],
"components":{"securitySchemes":{"auth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Cluster":{"type":"object","properties":{"uid":{"nullable":true,"type":"string"},"name":{"type":"string"},"cloud":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ClusterCloud"}]},"region":{"nullable":true,"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastTransmittedAt":{"type":"string","format":"date-time"}},"required":["uid","name","createdAt","lastTransmittedAt"]},"ClusterCloud":{"type":"string","enum":["aws","gcp","azure"]}}},"paths":{"/clusters":{"get":{"operationId":"GetClusters","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}}},"required":["data"]}}}}}}}}}

```

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

### Query Documentation Dynamically

Source: https://docs.perfectscale.io/enable-automation/troubleshooting

Use this HTTP GET request to query the documentation dynamically with a specific question. The response includes a direct answer and relevant excerpts.

```bash
GET https://docs.perfectscale.io/enable-automation/troubleshooting.md?ask=<question>
```

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

### Install PerfectScale Automation Agent

Source: https://docs.perfectscale.io/enable-automation/automation-setup-instructions

Installs or upgrades the PerfectScale Automation Agent (psc-autoscaler) in the 'perfectscale' namespace. Ensure the Helm repository is added first. Set 'secret.create=false' if you are managing secrets separately.

```bash
helm upgrade --install -n perfectscale psc-autoscaler \
      --set secret.create=false \
      perfectscale/psc-autoscaler
```

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

### Query Documentation Dynamically

Source: https://docs.perfectscale.io/administration/perfectscale-prometheus-exporter

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and in natural language. Use this mechanism for clarification, additional context, or to retrieve related documentation sections.

```bash
GET https://docs.perfectscale.io/administration/perfectscale-prometheus-exporter.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.perfectscale.io/administration/cluster-settings

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. Use this for clarifications or to retrieve related information not explicitly present.

```http
GET https://docs.perfectscale.io/administration/cluster-settings.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.perfectscale.io/customize-workflow/pricing/custom-pricing-configuration

Perform an HTTP GET request to query documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. The response will contain a direct answer and relevant excerpts.

```HTTP
GET https://docs.perfectscale.io/customize-workflow/pricing/custom-pricing-configuration.md?ask=<question>
```
Tokens:
Raw