Skip to content

Commit

Permalink
Added form template
Browse files Browse the repository at this point in the history
  • Loading branch information
@kyasbal
kyasbal committed Feb 10, 2025
1 parent add1225 commit 7e2d12e
Show file tree
Hide file tree
Showing 14 changed files with 271 additions and 206 deletions.
5 changes: 5 additions & 0 deletions cmd/document-generator/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ func main() {
err = generator.GenerateDocument("./docs/en/features.md", "feature-template", featureDocumentModel, false)
fatal(err, "failed to generate feature document")

formDocumentModel, err := model.GetFormDocumentModel(inspectionServer)
fatal(err, "failed to generate form document model")
err = generator.GenerateDocument("./docs/en/forms.md", "form-template", formDocumentModel, false)
fatal(err, "failed to generate form document")

relationshipDocumentModel := model.GetRelationshipDocumentModel()
err = generator.GenerateDocument("./docs/en/relationships.md", "relationship-template", relationshipDocumentModel, false)
fatal(err, "failed to generate relationship document")
Expand Down
157 changes: 79 additions & 78 deletions docs/en/features.md
View file

Large diffs are not rendered by default.

60 changes: 60 additions & 0 deletions docs/en/forms.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/project-id -->
## Project ID

The project ID containing the logs of cluster to query
<!-- END GENERATED PART: form-element-header-cloud.google.com/input/project-id -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/cluster-name -->
## Cluster name

The cluster name to gather logs.
<!-- END GENERATED PART: form-element-header-cloud.google.com/input/cluster-name -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/duration -->
## Duration

The duration of time range to gather logs. Supported time units are `h`,`m` or `s`. (Example: `3h30m`)
<!-- END GENERATED PART: form-element-header-cloud.google.com/input/duration -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/end-time -->
## End time

The endtime of the time range to gather logs. The start time of the time range will be this endtime subtracted with the duration parameter.
<!-- END GENERATED PART: form-element-header-cloud.google.com/input/end-time -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/kinds -->
## Kind

The kinds of resources to gather logs. `@default` is a alias of set of kinds that frequently queried. Specify `@any` to query every kinds of resources
<!-- END GENERATED PART: form-element-header-cloud.google.com/input/kinds -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/location -->
## Location


<!-- END GENERATED PART: form-element-header-cloud.google.com/input/location -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/namespaces -->
## Namespaces

The namespace of resources to gather logs. Specify `@all_cluster_scoped` to gather logs for all non-namespaced resources. Specify `@all_namespaced` to gather logs for all namespaced resources.
<!-- END GENERATED PART: form-element-header-cloud.google.com/input/namespaces -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/node-name-filter -->
## Node names


<!-- END GENERATED PART: form-element-header-cloud.google.com/input/node-name-filter -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/container-query-namespaces -->
## Namespaces(Container logs)


<!-- END GENERATED PART: form-element-header-cloud.google.com/input/container-query-namespaces -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/container-query-podnames -->
## Pod names(Container logs)


<!-- END GENERATED PART: form-element-header-cloud.google.com/input/container-query-podnames -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/component-names -->
## Control plane component names


<!-- END GENERATED PART: form-element-header-cloud.google.com/input/component-names -->
<!-- BEGIN GENERATED PART: form-element-header-cloud.google.com/input/composer/environment_name -->
## Composer Environment Name


<!-- END GENERATED PART: form-element-header-cloud.google.com/input/composer/environment_name -->
Binary file added docs/en/images/reference/default-timeline.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
112 changes: 18 additions & 94 deletions docs/en/inspection-type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,174 +12,98 @@ KHI filters out unsupported parser for the selected inspection type at first.
### Features

<!-- END GENERATED PART: inspection-type-element-header-gcp-gke -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gke -->

* [Kubernetes Audit Log](./features.md#k8s_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-k8s_event -->
* [Kubernetes Event Logs](./features.md#k8s_event)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-k8s_event -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-k8s_node -->
* [Kubernetes Node Logs](./features.md#k8s_node)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-k8s_node -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-k8s_container -->
* [Kubernetes container logs](./features.md#k8s_container)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-k8s_container -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-gke_audit -->
* [GKE Audit logs](./features.md#gke_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-gke_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-compute_api -->
* [Compute API Logs](./features.md#compute_api)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-compute_api -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-gce_network -->
* [GCE Network Logs](./features.md#gce_network)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-gce_network -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-autoscaler -->
* [Autoscaler Logs](./features.md#autoscaler)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-autoscaler -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-k8s_control_plane_component -->
* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-k8s_control_plane_component -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-serialport -->
* [Node serial port logs](./features.md#serialport)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-serialport -->
<!-- END GENERATED PART: inspection-type-element-header-features-gcp-gke -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer -->
## [Cloud Composer](#gcp-composer)

### Features

<!-- END GENERATED PART: inspection-type-element-header-gcp-composer -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-composer -->

* [Kubernetes Audit Log](./features.md#k8s_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-k8s_event -->
* [Kubernetes Event Logs](./features.md#k8s_event)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-k8s_event -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-k8s_node -->
* [Kubernetes Node Logs](./features.md#k8s_node)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-k8s_node -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-k8s_container -->
* [Kubernetes container logs](./features.md#k8s_container)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-k8s_container -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-gke_audit -->
* [GKE Audit logs](./features.md#gke_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-gke_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-compute_api -->
* [Compute API Logs](./features.md#compute_api)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-compute_api -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-gce_network -->
* [GCE Network Logs](./features.md#gce_network)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-gce_network -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-autoscaler -->
* [Autoscaler Logs](./features.md#autoscaler)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-autoscaler -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-k8s_control_plane_component -->
* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-k8s_control_plane_component -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-serialport -->
* [Node serial port logs](./features.md#serialport)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-serialport -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-airflow_schedule -->
* [(Alpha) Composer / Airflow Scheduler](./features.md#airflow_schedule)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-airflow_schedule -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-airflow_worker -->
* [(Alpha) Cloud Composer / Airflow Worker](./features.md#airflow_worker)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-airflow_worker -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-composer-airflow_dag_processor -->
* [(Alpha) Composer / Airflow DagProcessorManager](./features.md#airflow_dag_processor)
<!-- END GENERATED PART: inspection-type-element-header-gcp-composer-airflow_dag_processor -->
<!-- END GENERATED PART: inspection-type-element-header-features-gcp-composer -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws -->
## [GKE on AWS(Anthos on AWS)](#gcp-gke-on-aws)

### Features

<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gke-on-aws -->

* [Kubernetes Audit Log](./features.md#k8s_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_event -->
* [Kubernetes Event Logs](./features.md#k8s_event)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_event -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_node -->
* [Kubernetes Node Logs](./features.md#k8s_node)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_node -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_container -->
* [Kubernetes container logs](./features.md#k8s_container)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_container -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-multicloud_api -->
* [MultiCloud API logs](./features.md#multicloud_api)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-multicloud_api -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_control_plane_component -->
* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-aws-k8s_control_plane_component -->
<!-- END GENERATED PART: inspection-type-element-header-features-gcp-gke-on-aws -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure -->
## [GKE on Azure(Anthos on Azure)](#gcp-gke-on-azure)

### Features

<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gke-on-azure -->

* [Kubernetes Audit Log](./features.md#k8s_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_event -->
* [Kubernetes Event Logs](./features.md#k8s_event)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_event -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_node -->
* [Kubernetes Node Logs](./features.md#k8s_node)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_node -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_container -->
* [Kubernetes container logs](./features.md#k8s_container)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_container -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-multicloud_api -->
* [MultiCloud API logs](./features.md#multicloud_api)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-multicloud_api -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_control_plane_component -->
* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gke-on-azure-k8s_control_plane_component -->
<!-- END GENERATED PART: inspection-type-element-header-features-gcp-gke-on-azure -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal -->
## [GDCV for Baremetal(GKE on Baremetal, Anthos on Baremetal)](#gcp-gdcv-for-baremetal)

### Features

<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-baremetal -->

* [Kubernetes Audit Log](./features.md#k8s_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_event -->
* [Kubernetes Event Logs](./features.md#k8s_event)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_event -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_node -->
* [Kubernetes Node Logs](./features.md#k8s_node)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_node -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_container -->
* [Kubernetes container logs](./features.md#k8s_container)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_container -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-onprem_api -->
* [OnPrem API logs](./features.md#onprem_api)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-onprem_api -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_control_plane_component -->
* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-baremetal-k8s_control_plane_component -->
<!-- END GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-baremetal -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware -->
## [GDCV for VMWare(GKE on VMWare, Anthos on VMWare)](#gcp-gdcv-for-vmware)

### Features

<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-vmware -->

* [Kubernetes Audit Log](./features.md#k8s_audit)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_audit -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_event -->
* [Kubernetes Event Logs](./features.md#k8s_event)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_event -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_node -->
* [Kubernetes Node Logs](./features.md#k8s_node)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_node -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_container -->
* [Kubernetes container logs](./features.md#k8s_container)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_container -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-onprem_api -->
* [OnPrem API logs](./features.md#onprem_api)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-onprem_api -->
<!-- BEGIN GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_control_plane_component -->
* [Kubernetes Control plane component logs](./features.md#k8s_control_plane_component)
<!-- END GENERATED PART: inspection-type-element-header-gcp-gdcv-for-vmware-k8s_control_plane_component -->
<!-- END GENERATED PART: inspection-type-element-header-features-gcp-gdcv-for-vmware -->
Loading

0 comments on commit 7e2d12e

Please sign in to comment.