systemtest/fleettest/types.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package fleettest

import "time"

// Agent holds details of a Fleet Agent.
type Agent struct {
	ID                   string                 `json:"id"`
	Active               bool                   `json:"active"`
	Status               string                 `json:"status"`
	Type                 string                 `json:"type"`
	PolicyID             string                 `json:"policy_id,omitempty"`
	EnrolledAt           time.Time              `json:"enrolled_at,omitempty"`
	UserProvidedMetadata map[string]interface{} `json:"user_provided_metadata,omitempty"`
	LocalMetadata        map[string]interface{} `json:"local_metadata,omitempty"`
}

// AgentPolicy holds details of a Fleet Agent Policy.
type AgentPolicy struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Namespace   string `json:"namespace"`
	Description string `json:"description"`
	Revision    int    `json:"revision"`

	Agents            int       `json:"agents"`
	IsDefault         bool      `json:"is_default"`
	MonitoringEnabled []string  `json:"monitoring_enabled"`
	PackagePolicies   []string  `json:"package_policies"`
	Status            string    `json:"status"`
	UpdatedAt         time.Time `json:"updated_at"`
	UpdatedBy         string    `json:"updated_by"`
}

// PackagePolicy holds details of a Fleet Package Policy.
type PackagePolicy struct {
	ID            string               `json:"id,omitempty"`
	Name          string               `json:"name"`
	Namespace     string               `json:"namespace"`
	Enabled       bool                 `json:"enabled"`
	Description   string               `json:"description,omitempty"`
	AgentPolicyID string               `json:"policy_id"`
	OutputID      string               `json:"output_id,omitempty"`
	Inputs        []PackagePolicyInput `json:"inputs"`
	Package       struct {
		Name    string `json:"name"`
		Version string `json:"version"`
		Title   string `json:"title"`
	} `json:"package"`
}

type PackagePolicyInput struct {
	Type    string                 `json:"type"`
	Enabled bool                   `json:"enabled"`
	Streams []interface{}          `json:"streams"`
	Config  map[string]interface{} `json:"config,omitempty"`
	Vars    map[string]interface{} `json:"vars,omitempty"`
}

type Package struct {
	Name            string                  `json:"name"`
	Version         string                  `json:"version"`
	Release         string                  `json:"release"`
	Type            string                  `json:"type"`
	Title           string                  `json:"title"`
	Description     string                  `json:"description"`
	Download        string                  `json:"download"`
	Path            string                  `json:"path"`
	Status          string                  `json:"status"`
	PolicyTemplates []PackagePolicyTemplate `json:"policy_templates"`
}

type PackagePolicyTemplate struct {
	Inputs []PackagePolicyTemplateInput `json:"inputs"`
}

type PackagePolicyTemplateInput struct {
	Type         string                          `json:"type"`
	Title        string                          `json:"title"`
	TemplatePath string                          `json:"template_path"`
	Description  string                          `json:"description"`
	Vars         []PackagePolicyTemplateInputVar `json:"vars"`
}

type PackagePolicyTemplateInputVar struct {
	Name     string      `json:"name"`
	Type     string      `json:"type"`
	Default  interface{} `json:"default"`
	Required bool        `json:"required"`
	Multi    bool        `json:"multi"`
}

type EnrollmentAPIKey struct {
	ID        string    `json:"id"`
	Active    bool      `json:"active"`
	APIKeyID  string    `json:"api_key_id"`
	Name      string    `json:"name"`
	PolicyID  string    `json:"policy_id"`
	CreatedAt time.Time `json:"created_at"`

	// APIKey is only returned when querying a specific enrollment API key,
	// and not when listing keys.
	APIKey string `json:"api_key,omitempty"`
}