Skip to content
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
13 changes: 13 additions & 0 deletions .catalog-onboard-pipeline.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
apiVersion: v1
offerings:
- name: deploy-arch-ibm-observability-agents
kind: solution
catalog_id: _
offering_id: _
variations:
- name: standard
mark_ready: true
install_type: extension
pre_validation: "tests/scripts/pre-validation-deploy-slz-roks-and-obs-instances.sh"
post_validation: "tests/scripts/post-validation-destroy-slz-roks-and-obs-instances.sh"
3 changes: 3 additions & 0 deletions .releaserc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
}],
["@semantic-release/exec", {
"successCmd": "echo \"SEMVER_VERSION=${nextRelease.version}\" >> $GITHUB_ENV"
}],
["@semantic-release/exec", {
"publishCmd": "./ci/trigger-catalog-onboarding-pipeline.sh --version=v${nextRelease.version}"
}]
]
}
311 changes: 311 additions & 0 deletions ibm_catalog.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,311 @@
{
"products": [
{
"label": "[Add-ons Beta] Cloud automation for Observability Agents",
"name": "testing-deploy-arch-ibm-observability-agents",
"product_kind": "solution",
"tags": [
"ibm_created",
"logging_monitoring"
],
"short_description": "Deploys IBM Cloud Observability agents to a cluster",
"long_description": "Solutions that support deploying IBM Cloud Observability agents for logging, monitoring, and activity tracking.",
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-observability-agents/blob/main/README.md",
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/images/observability-icon.svg",
"flavors": [
{
"label": "Standard",
"name": "standard",
"working_directory": "solutions/standard",
"licenses": [
{
"id": "LICENSE",
"name": "LICENSE",
"type": "text/plain",
"description": "LICENSE"
}
],
"compliance": {},
"iam_permissions": [
{
"service_name": "containers-kubernetes",
"role_crns": [
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
"crn:v1:bluemix:public:iam::::role:Viewer"
]
}
],
"architecture": {
"features": [
{
"title": "Works with any openshift or k8s cluster",
"description": "Works with the Red Hat OpenShift cluster."
},
{
"title": "Deploys the IBM Cloud Monitoring agent on an existing cluster.",
"description": "Deploys the IBM Cloud Monitoring agent on an existing Red Hat OpenShift cluster."
},
{
"title": "Deploys the IBM Logs agent on an existing cluster.",
"description": "Deploys the IBM Logs agent on an existing Red Hat OpenShift cluster."
}
],
"diagrams": [
{
"diagram": {
"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-agents/refs/heads/addons/reference-architecture/deployable-architecture-observability-agents.svg",
"caption": "Observability agents on a Red Hat OpenShift cluster",
"type": "image/svg+xml"
},
"description": "Observability agents deployed on a Red Hat OpenShift cluster on a secure landing zone."
}
]
},
"dependencies": [
{
"name": "testing-deploy-arch-ibm-observability",
"id": "daf2cf91-2384-4205-b7f4-621299a4896d",
"version": ">=1.2.2",
"flavors": [
"standard"
],
"catalog_id": "f64499c8-eb50-4985-bf91-29f9e605a433",
"optional": true,
"input_mapping": [
{
"dependency_input": "log_analysis_provision",
"version_input": "log_analysis_enabled"
},
{
"dependency_output": "log_analysis_ingestion_key",
"version_input": "log_analysis_ingestion_key"
},
{
"dependency_input": "cloud_monitoring_provision",
"version_input": "cloud_monitoring_enabled"
},
{
"dependency_output": "cloud_monitoring_access_key",
"version_input": "cloud_monitoring_access_key"
},
{
"dependency_input": "region",
"version_input": "cloud_monitoring_instance_region"
}
]
}
],
"dependency_version_2": true,
"configuration": [
{
"key": "cloud_monitoring_access_key",
"required": true
},
{
"key": "cloud_monitoring_add_cluster_name",
"required": false
},
{
"key": "cloud_monitoring_agent_name",
"required": false
},
{
"key": "cloud_monitoring_agent_namespace",
"required": false
},
{
"key": "cloud_monitoring_agent_tags",
"required": false
},
{
"key": "cloud_monitoring_agent_tolerations",
"required": false
},
{
"key": "cloud_monitoring_enabled",
"required": true
},
{
"key": "cloud_monitoring_endpoint_type",
"required": false
},
{
"key": "cloud_monitoring_instance_region",
"display_name": "Region",
"required": true,
"custom_config": {
"type": "vpc_region",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cloud Monitoring may support different regions to VPC - I think we need to add a custom dropdown for this whuch only lists supported Cloud Monitoring regions

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

monitoring available in every region. what should i do here? how do i create or view the list of already existing custom configs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jor2 You will need to create your own dropdown list which only lists the regions that cloud monitoring is supported (same syntax as this https://github.com/terraform-ibm-modules/terraform-ibm-event-notifications/blob/564e73a43888d6fab2fd5706360a11167e8abd48/ibm_catalog.json#L74-L97)

"grouping": "deployment",
"original_grouping": "deployment",
"config_constraints": {
"generationType": "2"
}
}
},
{
"key": "cloud_monitoring_metrics_filter",
"required": false
},
{
"key": "cloud_monitoring_secret_name",
"required": false
},
{
"key": "cluster_config_endpoint_type",
"required": false
},
{
"key": "cluster_id",
"required": true
},
{
"key": "cluster_resource_group_id",
"required": true
},
{
"key": "cluster_data",
"required": true
},
{
"key": "ibmcloud_api_key",
"required": true
},
{
"key": "prefix",
"required": false
},
{
"key": "cloud_logs_ingress_endpoint",
"required": false
},
{
"key": "cloud_logs_ingress_port",
"required": false
},
{
"key": "is_vpc_cluster",
"required": false
},
{
"key": "logs_agent_additional_log_source_paths",
"required": false
},
{
"key": "logs_agent_additional_metadata",
"required": false
},
{
"key": "logs_agent_enable_scc",
"required": false
},
{
"key": "logs_agent_enabled",
"required": true
},
{
"key": "logs_agent_exclude_log_source_paths",
"required": false
},
{
"key": "logs_agent_iam_api_key",
"required": true
},
{
"key": "logs_agent_iam_environment",
"required": false
},
{
"key": "logs_agent_iam_mode",
"required": false
},
{
"key": "logs_agent_log_source_namespaces",
"required": false
},
{
"key": "logs_agent_name",
"required": false
},
{
"key": "logs_agent_namespace",
"required": false
},
{
"key": "logs_agent_selected_log_source_paths",
"required": false
},
{
"key": "logs_agent_tolerations",
"required": false
},
{
"key": "logs_agent_trusted_profile",
"required": false
},
{
"key": "wait_till",
"required": false
},
{
"key": "wait_till_timeout",
"required": false
}
],
"install_type": "extension",
"swappable_dependencies": [
{
"name": "cluster",
"default_dependency": "Testing_Retrieval_Augmented_Generation_Pattern_dev",
"description": "A cluster is required to deploy the agent too",
"optional": false,
"dependencies": [
{
"name": "deploy-arch-ibm-slz-ocp",
"id": "95fccffc-ae3b-42df-b6d9-80be5914d852-global",
"version": ">=v6.2.1",
"flavors": [
"standard"
],
"catalog_id": "1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc",
"optional": false,
"on_by_default": false,
"input_mapping": [
{
"dependency_output": "cluster_data",
"version_input": "cluster_data"
}
]
},
{
"name": "Testing_Retrieval_Augmented_Generation_Pattern_dev",
"id": "8e851423-4cfc-40e7-a008-fb449d953cb9",
"version": ">=1.2.4",
"flavors": [
"standard"
],
"catalog_id": "f64499c8-eb50-4985-bf91-29f9e605a433",
"optional": false,
"on_by_default": false,
"input_mapping": [
{
"dependency_output": "cluster_data",
"version_input": "cluster_data"
},
{
"value": "__NULL__",
"version_input": "cluster_id"
},
{
"value": "__NULL__",
"version_input": "cluster_resource_group_id"
}
]
}
]
}
]
}
]
}
]
}
1 change: 1 addition & 0 deletions images/observability-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions solutions/standard/catalogValidationValues.json.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"ibmcloud_api_key": $VALIDATION_APIKEY
}
6 changes: 6 additions & 0 deletions solutions/standard/kubeconfig/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Ignore everything
*

# But not these files...
!.gitignore
!README.md
2 changes: 2 additions & 0 deletions solutions/standard/kubeconfig/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This directory must exist in source control so the `ibm_container_cluster_config` data lookup can use it to place the
config.yml used to connect to a kubernetes cluster.
Loading