OpenSearch Dashboards Build Configuration#

1
schema-version: "1.2"
2
build:
3
  name: OpenSearch Dashboards
4
  version: 2.18.0
5
  platform: linux
6
  architecture: x64
7
  distribution: [deb|rpm|tar]
8
  id: unique-build-identifier
9
components:
10
  - name: component-name
11
    repository: git-repository-url
12
    ref: version-or-branch
13
    commit_id: specific-commit-hash
14
    artifacts:
15
      plugins:
16
        - plugins/plugin-name-version.zip
17
    version: semantic-version

1
---
2
schema-version: "1.2"
3
build:
4
  name: OpenSearch Dashboards
5
  version: 2.18.0
6
  platform: linux
7
  architecture: x64
8
  distribution: deb
9
  id: 71d717038f66462ca1c5e49883162343
10
components:
11
  - name: OpenSearch-Dashboards
12
    repository: https://github.com/Infopercept/xdr-dashboard-osd.git
13
    ref: 2.18.0
14
    commit_id: 1706584d94159e38a77dc50340786d00d582f4d8
15
    artifacts:
16
      dist:
17
        - dist/opensearch-dashboards-min-2.18.0-amd64.deb
18
    version: 2.18.0.0

1
---
2
schema-version: "1.2"
3
build:
4
  name: OpenSearch Dashboards
5
  version: 2.18.0
6
  platform: linux
7
  architecture: x64
8
  distribution: rpm
9
  id: 71d717038f66462ca1c5e49883162343
10
components:
11
  - name: OpenSearch-Dashboards
12
    repository: https://github.com/Infopercept/xdr-dashboard-osd.git
13
    ref: 2.18.0
14
    commit_id: 1706584d94159e38a77dc50340786d00d582f4d8
15
    artifacts:
16
      dist:
17
        - dist/opensearch-dashboards-min-2.18.0-x64.rpm
18
    version: 2.18.0.0

1
---
2
schema-version: "1.2"
3
build:
4
  name: OpenSearch Dashboards
5
  version: 2.18.0
6
  platform: linux
7
  architecture: x64
8
  distribution: tar
9
  id: 5c1e09cb1e714642ae7ffa9aedb26f40
10
components:
11
  - name: OpenSearch-Dashboards
12
    repository: https://github.com/Infopercept/xdr-dashboard-osd.git
13
    ref: 2.18.0
14
    commit_id: a0968a73d9ef7386dcd436f163bf6f5132a2c2f6
15
    artifacts:
16
      dist:
17
        - dist/opensearch-dashboards-min-2.18.0-linux-x64.tar.gz
18
    version: 2.18.0.0

1
graph TD
2
    A[OpenSearch Dashboards Core] --> B[Security Dashboards]
3
    A --> C[XDR Core]
4
    C --> D[Invinsense Plugin]
5
    C --> E[Update Checker]
6
    B --> F[Alerting Dashboard]
7
    A --> G[Index Management]
8
    A --> H[Observability]

1
# Version alignment for XDR components
2
xdr_components:
3
  ref_version: "4.9.2-abacus"
4
  opensearch_version: "2.18.0"
5
  plugin_compatibility: "2.18.0.0"

1
#!/bin/bash
2

3
# OpenSearch Dashboards Build Script
4
# Builds custom XDR-enabled OpenSearch Dashboards
5

6
set -e
7

8
MANIFEST_FILE="$1"
9
BUILD_OUTPUT="$2"
10
DISTRIBUTION_TYPE="${3:-deb}"
11

12
# Validate inputs
13
if [[ -z "$MANIFEST_FILE" || -z "$BUILD_OUTPUT" ]]; then
14
    echo "Usage: $0 <manifest_file> <build_output> [distribution_type]"
15
    exit 1
16
fi
17

18
# Parse manifest
19
echo "📋 Parsing manifest file: $MANIFEST_FILE"
20
BUILD_VERSION=$(grep -E "^\s+version:" "$MANIFEST_FILE" | head -1 | awk '{print $2}')
21
BUILD_PLATFORM=$(grep -E "^\s+platform:" "$MANIFEST_FILE" | awk '{print $2}')
22
BUILD_ARCH=$(grep -E "^\s+architecture:" "$MANIFEST_FILE" | awk '{print $2}')
23

24
echo "🔧 Building OpenSearch Dashboards $BUILD_VERSION for $BUILD_PLATFORM/$BUILD_ARCH"
25

26
# Create build environment
27
BUILD_DIR="/tmp/opensearch-build-$(date +%s)"
28
mkdir -p "$BUILD_DIR"
29
cd "$BUILD_DIR"
30

31
# Clone repositories and checkout specified commits
32
echo "📥 Cloning repositories..."
33
while read -r line; do
34
    if [[ $line =~ repository:.*github\.com ]]; then
35
        repo_url=$(echo "$line" | sed 's/.*repository: *//g')
36
        echo "Cloning: $repo_url"
37
        # Add actual cloning logic here
38
    fi
39
done < "$MANIFEST_FILE"
40

41
# Build process
42
echo "🔨 Starting build process..."
43
./build.sh --distribution="$DISTRIBUTION_TYPE" --platform="$BUILD_PLATFORM" --arch="$BUILD_ARCH"
44

45
# Package artifacts
46
echo "📦 Packaging artifacts..."
47
mv dist/* "$BUILD_OUTPUT/"
48

49
echo "✅ Build completed successfully"
50
echo "📍 Artifacts available at: $BUILD_OUTPUT"

1
#!/bin/bash
2

3
# Manifest validation script
4
validate_manifest() {
5
    local manifest_file="$1"
6

7
    echo "🔍 Validating manifest: $manifest_file"
8

9
    # Check schema version
10
    if ! grep -q "schema-version: '1.2'" "$manifest_file"; then
11
        echo "❌ Invalid schema version"
12
        return 1
13
    fi
14

15
    # Validate component structure
16
    if ! yq eval '.components | length > 0' "$manifest_file" > /dev/null; then
17
        echo "❌ No components defined"
18
        return 1
19
    fi
20

21
    # Check for required fields
22
    required_fields=("name" "version" "platform" "architecture")
23
    for field in "${required_fields[@]}"; do
24
        if ! yq eval ".build.${field}" "$manifest_file" > /dev/null; then
25
            echo "❌ Missing required field: build.${field}"
26
            return 1
27
        fi
28
    done
29

30
    echo "✅ Manifest validation passed"
31
    return 0
32
}

1
# Multi-stage build for production
2
FROM node:18-alpine AS builder
3

4
WORKDIR /usr/share/opensearch-dashboards
5
COPY manifests/opensearch-dashboards-tar.yml ./manifest.yml
6
COPY scripts/ ./scripts/
7

8
RUN ./scripts/build.sh manifest.yml ./dist tar
9

10
FROM opensearchproject/opensearch-dashboards:2.18.0
11

12
# Copy custom build
13
COPY --from=builder /usr/share/opensearch-dashboards/dist/* /usr/share/opensearch-dashboards/
14

15
# Install additional dependencies
16
USER root
17
RUN apt-get update && apt-get install -y \
18
    curl \
19
    && rm -rf /var/lib/apt/lists/*
20

21
USER opensearch-dashboards
22

23
# Health check
24
HEALTHCHECK --interval=30s --timeout=10s --start-period=60s --retries=3 \
25
    CMD curl -f http://localhost:5601/api/status || exit 1
26

27
EXPOSE 5601

1
#!/bin/bash
2

3
# OpenSearch Dashboards health check
4
check_dashboard_health() {
5
    local host="${1:-localhost}"
6
    local port="${2:-5601}"
7

8
    echo "🔍 Checking OpenSearch Dashboards health at $host:$port"
9

10
    # Check service status
11
    response=$(curl -s -o /dev/null -w "%{http_code}" "http://$host:$port/api/status")
12

13
    if [[ "$response" == "200" ]]; then
14
        echo "✅ OpenSearch Dashboards is healthy"
15
        return 0
16
    else
17
        echo "❌ OpenSearch Dashboards health check failed (HTTP $response)"
18
        return 1
19
    fi
20
}
21

22
# Plugin status check
23
check_plugin_status() {
24
    local host="${1:-localhost}"
25
    local port="${2:-5601}"
26

27
    echo "🔌 Checking plugin status"
28

29
    # Get plugin list
30
    plugins=$(curl -s "http://$host:$port/api/status" | jq -r '.status.statuses[] | select(.id | startswith("plugin:")) | .id')
31

32
    for plugin in $plugins; do
33
        status=$(curl -s "http://$host:$port/api/status" | jq -r ".status.statuses[] | select(.id == \"$plugin\") | .state")
34
        if [[ "$status" == "green" ]]; then
35
            echo "✅ $plugin: $status"
36
        else
37
            echo "⚠️ $plugin: $status"
38
        fi
39
    done
40
}