cwielenb/CNCF-Dataset huggingface dataset:
Project: Meshery (Provisioning / Automation & Configuration)
File: mesheryctl-mesh-validate.md

layout: default title: mesheryctl-mesh-validate permalink: reference/mesheryctl/mesh/validate redirect_from: reference/mesheryctl/mesh/validate/ type: reference display-title: "false" language: en command: mesh subcommand: validate Validate conformance to predefined standards Validate predefined conformance to different standard specifications <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl mesh validate [flags] </div> </pre> Validate conformance to predefined standards <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl mesh validate [mesh name] --adapter [name of the adapter] --tokenPath [path to token for authentication] --spec [specification to be used for conformance test] --namespace [namespace to be used] </div> </pre> Validate Istio to predefined standards <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl mesh validate istio --adapter meshery-istio --spec smi </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> -a, --adapter string (Required) Adapter to use for validation (default "meshery-nsm") -h, --help help for validate -s, --spec string (Required) specification to be used for conformance test (smi/istio-vet) (default "smi") -t, --token string Path to token for authenticating to Meshery API -w, --watch Watch for events and verify operation (in beta testing) </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> Usage of mesheryctl mesh validate Go back to , if you want to add content manually to the CLI documentation, please refer to the for guidance.
Project: Apollo (Provisioning / Automation & Configuration)
File: PULL_REQUEST_TEMPLATE.md

XXXXX Fixes # XXXXX Follow this checklist to help us incorporate your contribution quickly and easily: before making this pull request. [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. [ ] Write necessary unit tests to verify the code. [ ] Run `mvn clean test` to make sure this pull request doesn't break anything. .
Project: KICS (Provisioning / Security & Compliance)
File: defe5b18-978d-4722-9325-4d1975d3699f.md

title: Batch Job Definition With Privileged Container Properties hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: defe5b18-978d-4722-9325-4d1975d3699f Query name: Batch Job Definition With Privileged Container Properties Platform: Ansible Severity: <span style="color:#bb2124">High</span> Category: Insecure Configurations URL: Batch Job Definition should not have Privileged Container Properties<br> ```yaml title="Positive test num. 1 - yaml file" hl_lines="9" name: My Batch Job Definition community.aws.awsbatchjob_definition: jobdefinitionname: My Batch Job Definition state: present type: container parameters: Param1: Val1 Param2: Val2 privileged: true image: <Docker Image URL> vcpus: 1 memory: 512 command: python runmyscript.py arg1 jobrolearn: <Job Role ARN> attempts: 3 register: jobdefinitioncreate_result ``` ```yaml title="Negative test num. 1 - yaml file" name: My Batch Job Definition community.aws.awsbatchjob_definition: jobdefinitionname: My Batch Job Definition without privilege state: present type: container parameters: Param1: Val1 Param2: Val2 privileged: false image: <Docker Image URL> vcpus: 1 memory: 512 command: python runmyscript.py arg1 jobrolearn: <Job Role ARN> attempts: 3 register: jobdefinitioncreate_result name: My Batch Job Definition without explicit privilege community.aws.awsbatchjob_definition: jobdefinitionname: My Batch Job Definition state: present type: container parameters: Param1: Val1 Param2: Val2 image: <Docker Image URL> vcpus: 1 memory: 512 command: python runmyscript.py arg1 jobrolearn: <Job Role ARN> attempts: 3 register: jobdefinitioncreate_result ```
Project: CloudEvents (App Definition and Development / Streaming & Messaging)
File: adapters.md

<!-- no verify-specs --> Not all event producers will produce CloudEvents natively. As a result, some "adapter" might be needed to convert these events into CloudEvents. This will typically mean extracting metadata from the events to be used as CloudEvents attributes. In order to promote interoperability across multiple implementations of these adapters, the following documents show the proposed algorithms that should be used:
Project: CDK for Kubernetes (CDK8s) (Provisioning / Automation & Configuration)
File: api-object.md

An `ApiObject` is a construct that represents an entry in a Kubernetes manifest (level 0). In most cases, you won't use `ApiObject` directly but rather use classes that are imported through `cdk8s import` and which extend this base class. By default, when you import API objects from k8s, all class names will all be prefixed with `Kube` to differentiate them from the high-level APIs in cdk8s+. It is possible to customize the prefix by providing a string value to the `--class-prefix` flag, or by passing `--no-class-prefix`. (Note: if no prefix is used for k8s resources, this may lead to conflicts - see https://github.com/cdk8s-team/cdk8s/issues/140). By default, cdk8s will autogenerate a name for every resource when it is instantiated. The name is created from the path of the construct, and suffixed with a hash of that path. For example, the following code: ```ts import { App, Chart } from 'cdk8s'; import * as kplus from 'cdk8s-plus-29'; const app = new App(); const chart = new MyChart(app, 'my-chart'); new kplus.Deployment(chart, 'deployment', { containers: [{ image: 'nginx' }] }); app.synth(); ``` generates a `Deployment` with the name: `my-chart-deployment-c8c354dd`. Where `my-chart` is the id of the `Chart`, `deployment` is the id of the `Deployment`, and `c8c354dd` is the hash suffix. You can programmatically access the name of any resource in a cdk8s app by accessing the `.name` property of a resource. For example: ```ts const deployment = new kplus.Deployment(chart, 'deployment', { containers: [{ image: 'nginx' }] }); const deploymentName = deployment.name; ``` To remove hashes from resource names, you can set the `disableResourceNameHashes` property to `true`: ```ts ... const chart = new MyChart(app, 'my-chart', { disableResourceNameHashes: true, }); ... ``` Which would similarly generate a `Deployment` with the name: `my-chart-deployment`. Note that disabling hashes introduces the possibility of name clashes. For example, the following code: ```ts // think of this as a custom construct const c = new Construct(this, 'Construct'); new kplus.Deployment(c, 'Deployment', { containers: [{ image: 'image' }] }); new kplus.Deployment(this, 'Construct-Deployment', { containers: [{ image: 'image' }] }) ``` will produce two deployments with the same name: `chart-construct-deployment`. This happens because cdk8s uses a hyphen (`-`) as the delimiter between elements in the path, so if the id of your construct also contains a hyphen (`-`), a collision can occur. In addition, you can explicitly set a name for every resource by using the `metadata.name` property: ```ts new kplus.Deployment(c, 'Deployment', { metadata: { name: 'my-deployment' }, ... }); ```
Project: SeaTunnel (App Definition and Development / Streaming & Messaging)
File: savepoint.md

sidebar_position: 5 savepoint is created using the checkpoint. a global mirror of job execution status, which can be used for job or seatunnel stop and recovery, upgrade, etc. To use savepoint, you need to ensure that the connector used by the job supports checkpoint, otherwise data may be lost or duplicated. Make sure the job is running Use the following command to trigger savepoint: ```./bin/seatunnel.sh -s {jobId}``` After successful execution, the checkpoint data will be saved and the task will end. Resume from savepoint using jobId ```./bin/seatunnel.sh -c {jobConfig} -r {jobId}```
Project: YugabyteDB (App Definition and Development / Database)
File: cloud-add-ip.md

title: Before you begin headerTitle: Before you begin description: Obtain your cluster certificate and add your computer to the IP allow list. headcontent: Using a cluster in YugabyteDB Managed menu: v2.18: parent: build-apps name: Before you begin identifier: cloud-add-ip weight: 20 type: docs The tutorials assume you have deployed a YugabyteDB cluster in YugabyteDB Managed or locally. Refer to . In addition, if you are using YugabyteDB Managed, you need the following to run the sample applications: The cluster CA certificate. Your computer added to the cluster IP allow list. If your cluster is deployed in a VPC, you need Public Access enabled if you want to connect your application from a public IP address (this doesn't apply if you are using a Sandbox cluster). {{< note title="Note" >}} To use smart driver load balancing features when connecting to clusters in YugabyteDB Managed, applications using smart drivers must be deployed in a VPC that has been peered with the cluster VPC. For information on VPC networking in YugabyteDB Managed, refer to . For applications that access the cluster from a non-peered network, use the upstream PostgreSQL driver instead; in this case, the cluster performs the load balancing. Applications that use smart drivers from non-peered networks fall back to the upstream driver behaviour automatically. {{< /note >}} For more information on connecting applications in YugabyteDB Managed, refer to . YugabyteDB Managed uses TLS 1.2 for communicating with clusters, and digital certificates to verify the identity of clusters. The is used to verify the identity of the cluster when you connect to it from an application or client. To download the certificate to the computer that will be connecting to the cluster, do the following: In YugabyteDB Managed, select your cluster and click Connect. Click YugabyteDB Client Shell or Connect to your Application. Click Download CA Cert to download the cluster `root.crt` certificate to your computer. Access to YugabyteDB Managed clusters is limited to IP addresses that you explicitly allow using . To enable applications to connect to your cluster, you need to add your computer's IP address to the cluster IP allow list. To add your computer to the cluster IP allow list: In YugabyteDB Managed, select your cluster. Click Add IP Allow List. Click Create New List and Add to Cluster. Enter a name for the allow list. Click Detect and add my IP to this list to add your own IP address. Click Save. The allow list takes up to 30 seconds to become active. Clusters deployed in VPCs don't expose public IP addresses unless you explicitly turn on . If your cluster is in a VPC and you are connecting from a public IP address (such as your computer), enable Public Access on the cluster Settings tab.
Project: Meshery (Provisioning / Automation & Configuration)
File: v0.6.118.md

layout: release date: 2023-08-07 tag: v0.6.118 Remove old components dir @MUzairS15 (#8398) filter Unit test @Philip-21 (#8111) [UI] Fix MeshModel Chart empty when one of the contructs count is 0 @aabidsofi19 (#8388) [UI] Fix MeshModel Chart empty when one of the contructs count is 0 @aabidsofi19 (#8388) [chore] bump meshkit to `v0.6.52` @MUzairS15 (#8386) Thank you to our contributors for making this release possible: @MUzairS15, @Philip-21, @aabidsofi19, @leecalcote and @theBeginner86
Project: Chef InSpec (Provisioning / Security & Compliance)
File: google_cloudbuild_triggers.md

+++ title = "googlecloudbuildtriggers resource" draft = false gh_repo = "inspec" platform = "gcp" [menu] [menu.inspec] title = "googlecloudbuildtriggers" identifier = "inspec/resources/gcp/googlecloudbuildtriggers.md googlecloudbuildtriggers resource" parent = "inspec/resources/gcp" +++ A `googlecloudbuildtriggers` is used to test a Google Trigger resource ```ruby describe googlecloudbuildtriggers(project: 'chef-gcp-inspec') do its('count') { should eq 1 } end googlecloudbuildtriggers(project: 'chef-gcp-inspec').ids.each do |id| describe googlecloudbuildtrigger(project: 'chef-gcp-inspec', id: id) do its('filename') { should eq 'cloudbuild.yaml' } its('triggertemplate.branchname') { should eq 'trigger-branch' } its('triggertemplate.reponame') { should eq 'trigger-repo' } its('triggertemplate.projectid') { should eq 'trigger-project' } end end ``` Properties that can be accessed from the `googlecloudbuildtriggers` resource: See the resource for more information. `ids` : an array of `googlecloudbuildtrigger` id `names` : an array of `googlecloudbuildtrigger` name `descriptions` : an array of `googlecloudbuildtrigger` description `disableds` : an array of `googlecloudbuildtrigger` disabled `create_times` : an array of `googlecloudbuildtrigger` create_time `substitutions` : an array of `googlecloudbuildtrigger` substitutions `filenames` : an array of `googlecloudbuildtrigger` filename `ignored_files` : an array of `googlecloudbuildtrigger` ignored_files `included_files` : an array of `googlecloudbuildtrigger` included_files `trigger_templates` : an array of `googlecloudbuildtrigger` trigger_template `githubs` : (Beta only) an array of `googlecloudbuildtrigger` github `builds` : an array of `googlecloudbuildtrigger` build This resource supports all of the above properties as filter criteria, which can be used with `where` as a block or a method. Ensure the is enabled for the current project.
Project: YDB (App Definition and Development / Database)
File: enum.md

`Enum()` creates an enumeration value. Arguments: A string with the field name Enumeration type Example ```yql $enum_type = Enum<Foo, Bar>; SELECT Enum("Foo", $enum_type) as Enum1Value, Enum("Bar", $enum_type) as Enum2Value; ``` `AsEnum()` creates a value of including one element. This value can be implicitly cast to any enumeration containing such a name. Arguments: A string with the name of an enumeration item Example ```yql SELECT AsEnum("Foo"); ```
Project: Kui (App Definition and Development / Application Definition & Image Build)
File: tabs.md

Sections starting with a `=== "Tab name"` will be rendered as tabs, with the tab content indented by at least 4 spaces. ???+ tip "Tab Example" > Note how we are using tabs and hints nested inside of an expandable section! === "Output" === "Tab 1" Markdown content. Multiple paragraphs. === "Tab 2" More Markdown content. list item a list item b === "Markdown" ``` === "Tab 1" Markdown content. Multiple paragraphs. === "Tab 2" More Markdown content. list item a list item b ```
Project: Trivy-Operator (Provisioning / Security & Compliance)
File: bug_report.md

name: Bug report labels: kind/bug about: If something isn't working as expected. What steps did you take and what happened: [A clear and concise description of what the bug is, and what commands you ran.] What did you expect to happen: Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.] Environment: Trivy-Operator version (use `trivy-operator version`): Kubernetes version (use `kubectl version`): OS (macOS 10.15, Windows 10, Ubuntu 19.10 etc):
Project: StarRocks (App Definition and Development / Database)
File: exp.md

displayed_sidebar: "English" Returns the value of e raised to the power of `x`. This function is called natural logarithms function. ```SQL EXP(x); ``` `x`: the power number. DOUBLE is supported. Returns a value of the DOUBLE data type. Return e raised to the power of 3.14: ```Plaintext mysql> select exp(3.14); +--+ | exp(3.14) | +--+ | 23.103866858722185 | +--+ 1 row in set (0.01 sec) ```
Project: YugabyteDB (App Definition and Development / Database)
File: punsubscribe.md

title: PUNSUBSCRIBE linkTitle: PUNSUBSCRIBE description: PUNSUBSCRIBE menu: preview: parent: api-yedis weight: 2555 aliases: /preview/api/redis/punsubscribe /preview/api/yedis/punsubscribe type: docs `PUNSUBSCRIBE [pattern [pattern ...]]` This command unsubscribes the client from the specified pattern(s). If no pattern is specified, the client is unsubscribed from all patterns that it has subscribed to. , , , , , ,
Project: KubeDB by AppsCode (App Definition and Development / Database)
File: overview.md

title: Redis Volume Expansion Overview menu: docs_{{ .version }}: identifier: rd-volume-expansion-overview name: Overview parent: rd-volume-expansion weight: 10 menuname: docs{{ .version }} sectionmenuid: guides New to KubeDB? Please start . This guide will give an overview on how KubeDB Ops Manager expand the volume of `Redis`. You should be familiar with the following `KubeDB` concepts: - The following diagram shows how KubeDB Ops Manager expand the volumes of `Redis` database components. Open the image in a new tab to see the enlarged version. <figure align="center"> <img alt="Volume Expansion process of Redis" src="/docs/images/day-2-operation/redis/rd-volume-expansion.svg"> <figcaption align="center">Fig: Volume Expansion process of Redis</figcaption> </figure> The Volume Expansion process consists of the following steps: At first, a user creates a `Redis` Custom Resource (CR). `KubeDB` Community operator watches the `Redis` CR. When the operator finds a `Redis` CR, it creates required `StatefulSet` and related necessary stuff like secrets, services, etc. The statefulSet creates Persistent Volumes according to the Volume Claim Template provided in the statefulset configuration. This Persistent Volume will be expanded by the `KubeDB` Enterprise operator. Then, in order to expand the volume of the `Redis` database the user creates a `RedisOpsRequest` CR with desired information. `KubeDB` Enterprise operator watches the `RedisOpsRequest` CR. When it finds a `RedisOpsRequest` CR, it pauses the `Redis` object which is referred from the `RedisOpsRequest`. So, the `KubeDB` Community operator doesn't perform any operations on the `Redis` object during the volume expansion process. Then the `KubeDB` Enterprise operator will expand the persistent volume to reach the expected size defined in the `RedisOpsRequest` CR. After the successful expansion of the volume of the related StatefulSet Pods, the `KubeDB` Enterprise operator updates the new volume size in the `Redis` object to reflect the updated state. After the successful Volume Expansion of the `Redis`, the `KubeDB` Enterprise operator resumes the `Redis` object so that the `KubeDB` Community operator resumes its usual operations. In the next docs, we are going to show a step-by-step guide on Volume Expansion of various Redis database using `RedisOpsRequest` CRD.
Project: KICS (Provisioning / Security & Compliance)
File: ce9dfce0-5fc8-433b-944a-3b16153111a8.md

title: SSO Permission With Inadequate User Session Duration hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: ce9dfce0-5fc8-433b-944a-3b16153111a8 Query name: SSO Permission With Inadequate User Session Duration Platform: Terraform Severity: <span style="color:#edd57e">Low</span> Category: Access Control URL: SSO permissions should be configured to limit user sessions to no longer than 1 hour. Allowing longer sessions can increase the risk of unauthorized access or session hijacking. This is a best practice for security and should be implemented in SSO permission settings.<br> ```tf title="Positive test num. 1 - tf file" hl_lines="6 14" resource "awsssoadminpermission_set" "example3" { name = "Example" description = "An example" instancearn = tolist(data.awsssoadmin_instances.example.arns)[0] relay_state = "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#" session_duration = "PT1H1M" } resource "awsssoadminpermission_set" "example4" { name = "Example" description = "An example" instancearn = tolist(data.awsssoadmin_instances.example.arns)[0] relay_state = "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#" session_duration = "PT2H" } ``` ```tf title="Negative test num. 1 - tf file" resource "awsssoadminpermission_set" "example" { name = "Example" description = "An example" instancearn = tolist(data.awsssoadmin_instances.example.arns)[0] relay_state = "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#" session_duration = "PT1H" } resource "awsssoadminpermission_set" "example2" { name = "Example" description = "An example" instancearn = tolist(data.awsssoadmin_instances.example.arns)[0] relay_state = "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#" } ```
Project: YugabyteDB (App Definition and Development / Database)
File: ddl_comment.md

title: COMMENT statement [YSQL] headerTitle: COMMENT linkTitle: COMMENT description: Use the COMMENT statement to set, update, or remove a comment on a database object. menu: v2.18: identifier: ddl_comment parent: statements type: docs Use the `COMMENT` statement to set, update, or remove a comment on a database object. {{%ebnf%}} comment_on {{%/ebnf%}} To remove a comment, set the value to `NULL`. Add or change a comment about a database object. To remove a comment, set the value to `NULL`. ```plpgsql COMMENT ON DATABASE postgres IS 'Default database'; ``` ```plpgsql COMMENT ON INDEX index_name IS 'Special index'; ``` ```plpgsql COMMENT ON TABLE some_table IS NULL; ```
Project: KICS (Provisioning / Security & Compliance)
File: d47940ca-5970-45cc-bdd1-4d81398cee1f.md

title: Operation Summary Too Long hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: d47940ca-5970-45cc-bdd1-4d81398cee1f Query name: Operation Summary Too Long Platform: OpenAPI Severity: <span style="color:#5bc0de">Info</span> Category: Best Practices URL: Operation summary should be short (less than 120 characters)<br> ```json title="Positive test num. 1 - json file" hl_lines="11" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versionssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss", "responses": { "200": { "description": "200 response" } } } } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="9" swagger: "2.0" info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versionssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss responses: "200": description: "200 response" ``` ```json title="Negative test num. 1 - json file" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "produces": [ "application/json" ], "responses": { "200": { "description": "200 response" } } } } } } ``` ```yaml title="Negative test num. 2 - yaml file" swagger: "2.0" info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions produces: application/json responses: "200": description: 200 response ```
Project: Podman (App Definition and Development / Application Definition & Image Build)
File: secret.image.md

Pass secret information used in the Containerfile for building images in a safe way that are not stored in the final image, or be seen in other stages. The secret is mounted in the container at the default location of `/run/secrets/id`. To later use the secret, use the --mount option in a `RUN` instruction within a `Containerfile`: `RUN --mount=type=secret,id=mysecret cat /run/secrets/mysecret`
Project: Meshery (Provisioning / Automation & Configuration)
File: v0.7.2.1.md

layout: release date: 2023-12-12 tag: v0.7.2.1 chore : add text edit capabilty to textbox @aabidsofi19 (#9619) [ui] Status chip selector @senali-d (#9621) [cleanup] Remove Unused App UI Components @theBeginner86 (#9617) Thank you to our contributors for making this release possible: @MUzairS15, @aabidsofi19, @leecalcote, @senali-d and @theBeginner86