cwielenb/CNCF-Dataset huggingface dataset:
Project: Open Application Model (App Definition and Development / Application Definition & Image Build)
File: health_scope.md

The health scope aggregates health states for components. Parameters of the health scope can be set to determine the percentage of components that must be unhealthy to consider the entire scope unhealthy. The health scope on its own does not take any action based on health status. It is only a group health aggregator that can be queried and used by other processes and parts of an application, such as: Application upgrade traits can monitor the aggregate health of a health scope and decide when to initiate an automatic rollback. Monitoring applications can monitor the aggregate health of a health scope to issue alerts. | Attribute | Type | Required | Default Value | Description | |--||-||-| | `probe-timeout` | `int32` | Y | | ProbeTimeout is the amount of time in seconds to wait when receiving a response before marked failure.| | `probe-interval` | `int32` | Y | | ProbeInterval is the amount of time in seconds between probing tries. | For example, a health scope instance can be like below: ```yaml apiVersion: core.oam.dev/v1alpha2 kind: HealthScope metadata: name: example-health-scope spec: probe-timeout: 5 probe-interval: 5 ``` An application could reference above scope instance as below: ```yaml kind: Application metadata: name: example-appconfig spec: components: componentName: example-component traits: ... scopes: healthscopes.core.oam.dev: example-health-scope ```
Project: Operator Framework (App Definition and Development / Application Definition & Image Build)
File: operator-sdk_run_bundle-upgrade.md

title: "operator-sdk run bundle-upgrade" Upgrade an Operator previously installed in the bundle format with OLM The single argument to this command is a bundle image, with the full registry path specified. If using a docker.io image, you must specify docker.io(/&lt;namespace&gt;)?/&lt;bundle-image-name&gt;:&lt;tag&gt;. If the bundle image provided is a SQLite index, it must be pullable by the cluster as SQLite images are pulled from the cluster. If the bundle image provided is a File-Based Catalog (FBC) index, it will be pulled on the local machine. ``` operator-sdk run bundle-upgrade <bundle-image> [flags] ``` ``` --ca-secret-name string Name of a generic secret containing a PEM root certificate file required to pull bundle images. This secret must be in the namespace that this command is configured to run in, and the file must be encoded under the key "cert.pem" -h, --help help for bundle-upgrade --kubeconfig string Path to the kubeconfig file to use for CLI requests. -n, --namespace string If present, namespace scope for this CLI request --pull-secret-name string Name of image pull secret ("type: kubernetes.io/dockerconfigjson") required to pull bundle images. This secret must be both in the namespace and an imagePullSecret of the service account that this command is configured to run in --security-context-config SecurityContext specifies the security context to use for the catalog pod. allowed: 'restricted', 'legacy'. (default legacy) --service-account string Service account name to bind registry objects to. If unset, the default service account is used. This value does not override the operator's service account --skip-tls skip authentication of image registry TLS certificate when pulling a bundle image in-cluster --skip-tls-verify skip TLS certificate verification for container image registries while pulling bundles --timeout duration Duration to wait for the command to complete before failing (default 2m0s) --use-http use plain HTTP for container image registries while pulling bundles ``` ``` --plugins strings plugin keys to be used for this subcommand execution --verbose Enable verbose logging ``` - Run an Operator in a variety of environments
Project: Podman (App Definition and Development / Application Definition & Image Build)
File: gidmap.container.md

Run the container in a new user namespace using the supplied GID mapping. This option conflicts with the --userns and --subgidname options. This option provides a way to map host GIDs to container GIDs in the same way as --uidmap maps host UIDs to container UIDs. For details see --uidmap. Note: the --gidmap option cannot be called in conjunction with the --pod option as a gidmap cannot be set on the container level when in a pod.
Project: GraphScope (App Definition and Development / Database)
File: networkx_compatibility.md

NetworkX is a Python package for manipulating and processing graph data on a single machine. It provides user-friendly interfaces for working with graph data and developing graph-based applications. Currently, it is widely used by graph application developers and researchers, particularly in the field of data science. However, it does not have the capability to handle large-scale graphs on a distributed environment. To solve this problem, GraphScope provides a NetworkX-compatible interface, which allows users who have used NetworkX for their graph analysis on small graphs to use GraphScope for large graphs with minimal changes.
Project: Meshery (Provisioning / Automation & Configuration)
File: v0.7.30.md

layout: release date: 2024-03-08 tag: v0.7.30 feat: Relationship between Volume attachment and PersistentVolume @RipulHandoo (#10481) Delete unused file: custom.hbs @leecalcote (#10475) Delete unused redocly.yaml file from repo root @leecalcote (#10476) Update README.md @leecalcote (#10519) add make target for using remote provider in staging environment @MUzairS15 (#10521) [Server] Regenerate error codes for meshery server @MUzairS15 (#10520) [mesheryctl] Fix Registry usage error message link @tico88612 (#10522) Fixing the test failure @Althaf66 (#10484) Bump eslint-plugin-prettier from 5.0.0 to 5.1.3 in /ui @dependabot (#10467) Bump @cypress/code-coverage from 3.12.19 to 3.12.26 in /provider-ui @dependabot (#10462) Bump @mui/icons-material from 5.11.16 to 5.15.11 in /ui @dependabot (#10468) Bump @mui/material from 5.15.7 to 5.15.11 in /provider-ui @dependabot (#10459) [chore] Flatten the metadata and update UI. @MUzairS15 (#10525) Bump eslint-plugin-prettier from 5.0.0 to 5.1.3 in /ui @dependabot (#10467) Bump @cypress/code-coverage from 3.12.19 to 3.12.26 in /provider-ui @dependabot (#10462) Bump @mui/icons-material from 5.11.16 to 5.15.11 in /ui @dependabot (#10468) Bump @mui/material from 5.15.7 to 5.15.11 in /provider-ui @dependabot (#10459) [Models]: Updating Issue Template @pandeyshubham03 (#10523) [Docs] Meshery Docs Contributing summarization @leecalcote (#10500) add id for error codes @vishalvivekm (#10526) Thank you to our contributors for making this release possible: @Althaf66, @MUzairS15, @RipulHandoo, @dependabot, @l5io, @leecalcote, @pandeyshubham03, @tico88612, @vishalvivekm and l5io
Project: Artifact Hub (App Definition and Development / Application Definition & Image Build)
File: olm_operators_repositories.md

OLM operators repositories are expected to be hosted in GitHub, GitLab or Bitbucket repos. When adding your repository to Artifact Hub, the url used must follow the following format: `https://github.com/user/repo[/path/to/packages]` `https://gitlab.com/user/repo[/path/to/packages]` `https://bitbucket.org/user/repo[/path/to/packages]` By default the `master` branch is used, but it's possible to specify a different one from the UI. Please NOTE that the repository URL used when adding the repository to Artifact Hub must NOT contain the git hosting platform specific parts, like tree/branch, just the path to your operators like it would show in the filesystem. The path to operators provided can contain one or more operators, that must be packaged using the . This is exactly the same format required to publish operators in . We've adopted this format for this repository kind because of its well thought structure and to make it easier for publishers to start listing their content in Artifact Hub. Both `PackageManifest` and `Bundle` formats are supported. Most of the metadata Artifact Hub needs is extracted from the file and other files in the operator package. However, there is some extra Artifact Hub specific metadata that you can set using some special annotations in the `CSV` file. For more information, please see the . There is an extra metadata file that you can add to your repository named , which can be used to setup features like or . This file must be located at `/path/to/packages`. Once you have added your repository, you are all set up. As you add new versions of your operators or even new operators to your git repository, they'll be automatically indexed and listed in Artifact Hub. To delete a specific version or operator from Artifact Hub, you just need to delete the corresponding directory from your repository. This should make it easier to keep your content up-to-date in Artifact Hub without requiring any extra effort on your side. Artifact Hub is able to process OLM repositories stored in . This feature is experimental, and it's subject to change when . To add a repository stored in a OCI registry, you need to provide the catalog index image url when registering your repository. The url used must follow the following format: `oci://docker.io/ibmcom/ibm-operator-catalog:latest` OCI specific installation instructions will be provided in the UI for packages available in OCI registries. Please note that there are some features that are not yet available for OLM repositories stored in OCI registries: Operators source GitHub URL: Repository URL used in Artifact Hub: `https://github.com/ctron/ditto-operator/olm` (please note how the tree/master part is not used) Operator displayed in Artifact Hub:
Project: Meshery (Provisioning / Automation & Configuration)
File: mesheryctl-completion.md

layout: default title: mesheryctl-completion permalink: reference/mesheryctl/completion redirect_from: reference/mesheryctl/completion/ type: reference display-title: "false" language: en command: completion subcommand: nil Output shell completion code Output shell completion code <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl completion [bash|zsh|fish] </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> source /dev/stdin <<< "$(mesheryctl completion bash)" </div> </pre> bash <= 3.2 on osx ensure you have bash-completion 1.3+ <pre class='codeblock-pre'> <div class='codeblock'> brew install bash-completion </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl completion bash > $(brew --prefix)/etc/bash_completion.d/mesheryctl </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> source <(mesheryctl completion bash) </div> </pre> bash >= 4.0 on osx <pre class='codeblock-pre'> <div class='codeblock'> brew install bash-completion@2 </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl completion bash > $(brew --prefix)/etc/bash_completion.d/mesheryctl </div> </pre> If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once: Might need to start a new shell for this setup to take effect. <pre class='codeblock-pre'> <div class='codeblock'> $ echo "autoload -U compinit; compinit" >> ~/.zshrc </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> source <(mesheryctl completion zsh) </div> </pre> zsh on osx / oh-my-zsh <pre class='codeblock-pre'> <div class='codeblock'> COMPLETIONDIR=$(echo $fpath | grep -o '[^ ]*completions' | grep -v cache) && mkdir -p $COMPLETIONDIR && mesheryctl completion zsh > "${COMPLETIONDIR}/mesheryctl" </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl completion fish | source </div> </pre> To load fish shell completions for each session, execute once: <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl completion fish > ~/.config/fish/completions/mesheryctl.fish </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> -h, --help help for completion </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> --config string path to config file (default "/home/runner/.meshery/config.yaml") -v, --verbose verbose output </div> </pre> Go back to , if you want to add content manually to the CLI documentation, please refer to the for guidance.
Project: Shifu (Provisioning / Automation & Configuration)
File: design-deviceShifu-tcp.md

deviceShifu-TCP allows Shifu connect to any server which protocol based tcp and forward it out, like nginx. deviceShifu-TCP can forward all data from target to support all protocol base tcp. Create a deviceShifu-TCP forward the all data from target server, user can connect to deviceShifu-TCP to connect the device. deviceShifu-TCP just forward all data from target server out, user can connect to deviceShifu-TCP like to connect the real device by tcp. deviceShifu-TCP not support RESTful API edgedevice.yaml ```yaml spec: sku: tcp Device connection: Ethernet address: 192.168.0.1:1080 protocol: TCP ``` forward TCP protocol: using mock tcp server and try to connect to the server with deviceShifu-TCP forward HTTP protocol: using mock tcp server and try to connect to the server with deviceShifu-TCP forward RTSP protocol: use Hikvision / Dahua Camera, try to connect to the server with deviceShifu-TCP
Project: StarRocks (App Definition and Development / Database)
File: SET_PASSWORD.md

displayed_sidebar: "English" Changes login password for users. The command can also be used to change a password. :::tip All users can reset their own password. Only users with the `user_admin` role can change the password of other users. Only the `root` user itself can change its password. For more information, see . ::: ```SQL SET PASSWORD [FOR user_identity] = [PASSWORD('plain password')]|['hashed password'] ``` The `useridentity` must match exactly the `useridentity` specified when creating a user by using CREATE USER. Otherwise, the user will be reported as non-existent. If `user_identity` is not specified, the password of the current user will be changed. The current user can be viewed through . `PASSWORD()` inputs a plaintext password. If you directly input a string without using `PASSWORD()`, the string must be encrypted. Set the password for the current user. ```SQL SET PASSWORD = PASSWORD('123456') SET PASSWORD = '*6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9' ``` Set the password for a specified user. ```SQL SET PASSWORD FOR 'jack'@'192.%' = PASSWORD('123456') SET PASSWORD FOR 'jack'@['domain'] = '*6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9' ```
Project: KICS (Provisioning / Security & Compliance)
File: b9033580-6886-401a-8631-5f19f5bb24c7.md

title: Workspaces Workspace Volume Not Encrypted hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: b9033580-6886-401a-8631-5f19f5bb24c7 Query name: Workspaces Workspace Volume Not Encrypted Platform: Terraform Severity: <span style="color:#bb2124">High</span> Category: Encryption URL: AWS Workspaces Workspace data stored in volumes should be encrypted<br> ```tf title="Positive test num. 1 - tf file" hl_lines="11" resource "awsworkspacesworkspace" "example" { directoryid = awsworkspaces_directory.example.id bundleid = data.awsworkspacesbundle.valuewindows_10.id user_name = "john.doe" rootvolumeencryption_enabled = true volumeencryptionkey = "alias/aws/workspaces" workspace_properties { computetypename = "VALUE" uservolumesize_gib = 10 rootvolumesize_gib = 80 runningmode = "AUTOSTOP" runningmodeautostoptimeoutinminutes = 60 } tags = { Department = "IT" } } ``` ```tf title="Positive test num. 2 - tf file" hl_lines="12" resource "awsworkspacesworkspace" "example_2" { directoryid = awsworkspaces_directory.example.id bundleid = data.awsworkspacesbundle.valuewindows_10.id user_name = "john.doe" uservolumeencryption_enabled = true volumeencryptionkey = "alias/aws/workspaces" workspace_properties { computetypename = "VALUE" uservolumesize_gib = 10 rootvolumesize_gib = 80 runningmode = "AUTOSTOP" runningmodeautostoptimeoutinminutes = 60 } tags = { Department = "IT" } } ``` ```tf title="Positive test num. 3 - tf file" hl_lines="10 11" resource "awsworkspacesworkspace" "example_3" { directoryid = awsworkspaces_directory.example.id bundleid = data.awsworkspacesbundle.valuewindows_10.id user_name = "john.doe" volumeencryptionkey = "alias/aws/workspaces" workspace_properties { computetypename = "VALUE" uservolumesize_gib = 10 rootvolumesize_gib = 80 runningmode = "AUTOSTOP" runningmodeautostoptimeoutinminutes = 60 } tags = { Department = "IT" } } ``` <details><summary>Positive test num. 4 - tf file</summary> ```tf hl_lines="6 7" resource "awsworkspacesworkspace" "example_4" { directoryid = awsworkspaces_directory.example.id bundleid = data.awsworkspacesbundle.valuewindows_10.id user_name = "john.doe" rootvolumeencryption_enabled = false uservolumeencryption_enabled = false volumeencryptionkey = "alias/aws/workspaces" workspace_properties { computetypename = "VALUE" uservolumesize_gib = 10 rootvolumesize_gib = 80 runningmode = "AUTOSTOP" runningmodeautostoptimeoutinminutes = 60 } tags = { Department = "IT" } } ``` </details> ```tf title="Negative test num. 1 - tf file" resource "awsworkspacesworkspace" "example" { directoryid = awsworkspaces_directory.example.id bundleid = data.awsworkspacesbundle.valuewindows_10.id user_name = "john.doe" rootvolumeencryption_enabled = true uservolumeencryption_enabled = true volumeencryptionkey = "alias/aws/workspaces" workspace_properties { computetypename = "VALUE" uservolumesize_gib = 10 rootvolumesize_gib = 80 runningmode = "AUTOSTOP" runningmodeautostoptimeoutinminutes = 60 } tags = { Department = "IT" } } ```
Project: Meshery (Provisioning / Automation & Configuration)
File: mesheryctl-system-provider-view.md

layout: default title: mesheryctl-system-provider-view permalink: reference/mesheryctl/system/provider/view redirect_from: reference/mesheryctl/system/provider/view/ type: reference display-title: "false" language: en command: system subcommand: provider view provider View provider of context in focus <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl system provider view [flags] </div> </pre> View current provider <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl system provider view </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> -a, --all Show provider for all contexts -h, --help help for view </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> --config string path to config file (default "/home/runner/.meshery/config.yaml") -c, --context string (optional) temporarily change the current context. -v, --verbose verbose output -y, --yes (optional) assume yes for user interactive prompts. </div> </pre> Go back to , if you want to add content manually to the CLI documentation, please refer to the for guidance.
Project: FOSSA (Provisioning / Security & Compliance)
File: ssl-cert.md

`fossa-cli` uses the path provided in the following environment variable to infer root certificate store: 1) `SSLCERTFILE` 2) `SSLCERTDIR` 3) `SYSTEMCERTIFICATEPATH` (only for linux) If none of these environment variables are provided, fossa-cli uses a system store to retrieve signed certificates. `fossa-cli` looks for certificate store in the following paths: `/etc/ssl/certs/` `/system/etc/security/cacerts/` `/usr/local/share/certs/` `/etc/ssl/cert.pem` `fossa-cli` creates a certificate store by finding all signed certificates. We use following command to retrieve all signed certificates: `security find-certificate -pa /System/Library/Keychains/SystemRootCertificates.keychain /Library/Keychains/System.keychain` `fossa-cli` retrieves certificates store by performing, From which, perform until exhaustion to retrieve all signed certificates. We recommended that you leverage the operating system's certificate store instead of using environment variables. In Windows: ``` $Env:SSLCERTFILE = "\path\to\rootCa" fossa analyze ``` In Linux: ``` SSLCERTFILE=path/to/rootCa fossa analyze ``` In Osx: ``` SSLCERTFILE=path/to/rootCa fossa analyze ```
Project: Tetragon (Provisioning / Security & Compliance)
File: container.md

title: "Deploy as a container" linkTitle: "Container" weight: 2 description: "Install and manage Tetragon as a container without a Kubernetes cluster" To run a stable version, please check and select which version you want. For example if you want to run the latest version which is `{{< latest-version >}}` currently. ```shell docker run --name tetragon --rm -d \ --pid=host --cgroupns=host --privileged \ -v /sys/kernel/btf/vmlinux:/var/lib/tetragon/btf \ quay.io/cilium/tetragon:{{< latest-version >}} ``` To run unstable development versions of Tetragon, use the `latest` tag from . This will run the image that was built from the latest commit available on the Tetragon main branch. ```shell docker run --name tetragon --rm -d \ --pid=host --cgroupns=host --privileged \ -v /sys/kernel/btf/vmlinux:/var/lib/tetragon/btf \ quay.io/cilium/tetragon-ci:latest ``` {{< note >}} If Tetragon does not start due to BTF issues, please refer to the for details and solutions. {{< /note >}} There are multiple ways to set configuration options: Append Tetragon controlling settings at the end of the command As an example set the file where to export JSON events with `--export-filename` argument: ```shell docker run --name tetragon --rm -d \ --pid=host --cgroupns=host --privileged \ -v /sys/kernel:/sys/kernel \ quay.io/cilium/tetragon:{{< latest-version >}} \ /usr/bin/tetragon --export-filename /var/log/tetragon/tetragon.log ``` For a complete list of CLI arguments, please check . Environment variables ```shell docker run --name tetragon --rm -d \ --pid=host --cgroupns=host --privileged \ --env "TETRAGONEXPORTFILENAME=/var/log/tetragon/tetragon.log" \ -v /sys/kernel:/sys/kernel \ quay.io/cilium/tetragon:{{< latest-version >}} ``` Every controlling setting can be set using environment variables. Prefix it with the key word `TETRAGON` then upper case the controlling setting. As an example to set where to export JSON events: `--export-filename` will be `TETRAGONEXPORT_FILENAME`. For a complete list of all controlling settings, please check . Configuration files mounted as volumes On the host machine set the configuration drop-ins inside `/etc/tetragon/tetragon.conf.d/` directory according to the , then mount it as volume: ```shell docker run --name tetragon --rm -d \ --pid=host --cgroupns=host --privileged \ -v /sys/kernel:/sys/kernel \ -v /etc/tetragon/tetragon.conf.d/:/etc/tetragon/tetragon.conf.d/ \ quay.io/cilium/tetragon:{{< latest-version >}} ``` This will map the `/etc/tetragon/tetragon.conf.d/` drop-in directory from the host into the container. See reference for further details.