cwielenb/CNCF-Dataset huggingface dataset:
Project: KICS (Provisioning / Security & Compliance)
File: e3f026e8-fdb4-4d5a-bcfd-bd94452073fe.md

title: Security Definitions Undefined or Empty hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: e3f026e8-fdb4-4d5a-bcfd-bd94452073fe Query name: Security Definitions Undefined or Empty Platform: OpenAPI Severity: <span style="color:#bb2124">High</span> Category: Access Control URL: Security Definitions Object should be set and not empty<br> ```json title="Positive test num. 1 - json file" hl_lines="2" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } }, "securityDefinitions": {} } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="1" swagger: "2.0" info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response securityDefinitions: {} ``` ```json title="Positive test num. 3 - json file" hl_lines="2" { "swagger": "2.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response" } } } } } } ``` <details><summary>Positive test num. 4 - yaml file</summary> ```yaml hl_lines="1" swagger: "2.0" info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response ``` </details> ```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", "responses": { "200": { "description": "200 response" } } } } }, "securityDefinitions": { "BasicAuth": { "type": "basic" }, "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "OAuth2": { "type": "oauth2", "flow": "accessCode", "authorizationUrl": "https://example.com/oauth/authorize", "tokenUrl": "https://example.com/oauth/token", "scopes": { "read": "Grants read access", "write": "Grants write access", "admin": "Grants read and write access to administrative information" } } } } ``` ```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 responses: "200": description: 200 response securityDefinitions: BasicAuth: type: basic ApiKeyAuth: type: apiKey in: header name: X-API-Key OAuth2: type: oauth2 flow: accessCode authorizationUrl: https://example.com/oauth/authorize tokenUrl: https://example.com/oauth/token scopes: read: Grants read access write: Grants write access admin: Grants read and write access to administrative information ```
Project: YDB (App Definition and Development / Database)
File: check-match.md

`REGEXP` and `RLIKE` are aliases used to call . `MATCH`: Same for . `LIKE` works as follows: Patterns can include two special characters: `%`: Zero or more of any characters. `_`: Exactly one of any character. All other characters are literals that represent themselves. As opposed to `REGEXP`, `LIKE` must be matched exactly. For example, to search a substring, add `%` at the beginning and end of the pattern. `ILIKE` is a case-insensitive version of `LIKE`. If `LIKE` is applied to the key column of the sorted table and the pattern doesn't start with a special character, filtering by prefix drills down directly to the cluster level, which in some cases lets you avoid the full table scan. This optimization is disabled for `ILIKE`. To escape special characters, specify the escaped character after the pattern using the `ESCAPE '?'` keyword. Instead of `?` you can use any character except `%` and ``. For example, if you use a question mark as an escape character, the expressions `?%`, `?` and `??` will match their second character in the template: percent, underscore, and question mark, respectively. The escape character is undefined by default. The most popular way to use the `LIKE` and `REGEXP` keywords is to filter a table using the statements with the `WHERE` clause. However, there are no restrictions on using templates in this context: you can use them in most of contexts involving strings, for example, with concatenation by using `||`. Examples ```yql SELECT * FROM my_table WHERE string_column REGEXP '\\d+'; -- the second slash is required because -- all the standard string literals in SQL -- can accept C-escaped strings ``` ```yql SELECT stringcolumn LIKE '!!!_!!!!!!' ESCAPE '!' -- searches for a string of exactly 9 characters: -- 3 arbitrary characters -- followed by 3 underscores -- and 3 exclamation marks FROM my_table; ``` ```yql SELECT * FROM my_table WHERE key LIKE 'foo%bar'; -- if the table is sorted by key, it will only scan the keys, -- starting with "foo", and then, among them, -- will leave only those that end in "bar" ```
Project: CloudEvents (App Definition and Development / Streaming & Messaging)
File: proprietary-specs.md

<!-- no verify-specs --> Disclaimer: CloudEvents does not endorse these protocols or specs, and does not ensure that they are up to date with the current version of CloudEvents. That is the responsibility of the respective project maintainers. Want to add a binding to a proprietary transport? Create a spec that follows the structure of an existing binding specification (e.g. or ) - this will help SDK development. NOTES: The spec must be publicly accessible and managed by the proposing organization. The spec must clearly state the version(s) of CloudEvents supported. Open a pull request against this file. Respond to any comments on the pull request and potentially join one of the regularly scheduled working group sessions.
Project: Meshery (Provisioning / Automation & Configuration)
File: v0.6.63.md

layout: release date: 2023-03-13 tag: v0.6.63 add endpoint to get user by id (uuid) @MUzairS15 (#7301) Modify `Default` to `default` in token @alphaX86 (#7311) [UI] Color of Metrics Tab when selected fixed @soham4abc (#7294) New MeshModel Icons added @ritiksaxena124 (#7335) fixed the alignment and space of some icons @sidtohan (#7277) [bug] Handle Meshery server de-registration gracefully @theBeginner86 (#7310) aligned meshery operator with the heading @Ambareen09 (#7282) fix table header background color on click @rinkuhasija (#7333) added "language: en" to the frontmatter of all Docs pages that are in English @hirentimbadiya (#7315) kubernetes versions are sorted in descending order in the compatibili @sudhanshutech (#7331) Bump rack from 2.2.6.2 to 2.2.6.3 in /docs @dependabot (#7316) Modify `Default` to `default` in token @alphaX86 (#7311) Thank you to our contributors for making this release possible: @Abhishek-kumar09, @Ambareen09, @Chadha93, @MUzairS15, @Nikhil-Ladha, @Revolyssup, @alphaX86, @dependabot, @dependabot[bot], @hirentimbadiya, @leecalcote, @rinkuhasija, @ritiksaxena124, @sidtohan, @soham4abc, @sudhanshutech, @theBeginner86 and MUzairS15
Project: Kui (App Definition and Development / Application Definition & Image Build)
File: kui_shell_plugin_kubectl.Job.md

/ / Job .Job Kubernetes Job resource type `Job` apiVersion: `"batch/v1"` KubeResource.apiVersion `Optional` content: `void` KubeResource.content packages/core/mdist/models/entity.d.ts:50 `Optional` contentType: `string` KubeResource.contentType packages/core/mdist/models/entity.d.ts:51 isKubeResource: `true` KubeResource.isKubeResource `Optional` isSimulacrum: `boolean` KubeResource.isSimulacrum kind: `"Job"` KubeResource.kind `Optional` kuiRawData: `string` KubeResource.kuiRawData `Optional` metadata: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } KubeResource.metadata packages/core/mdist/models/entity.d.ts:23 `Optional` nameHash: `string` KubeResource.nameHash packages/core/mdist/models/entity.d.ts:42 `Optional` onclick: `Object` family of onclick handlers | Name | Type | | :-- | :- | | `kind?` | `string` | | `name?` | `string` | | `nameHash?` | `string` | | `namespace?` | `string` | KubeResource.onclick packages/core/mdist/models/entity.d.ts:44 originatingCommand: `EvaluatorArgs`<\> KubeResource.originatingCommand `Optional` presentation: `Presentation` KubeResource.presentation packages/core/mdist/models/entity.d.ts:53 `Optional` prettyName: `string` name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id KubeResource.prettyName packages/core/mdist/models/entity.d.ts:41 spec: `Object` | Name | Type | | :- | :-- | | `backoffLimit` | `number` | | `completions` | `number` | | `parallelism` | `number` | | `selector` | `Selector` | | `template` | `ContainerTemplate`<{ `controller-uid`: `string` ; `job-name`: `string` }\> | KubeResource.spec status: `Object` | Name | Type | | : | :- | | `completionTime` | `string` | | `conditions` | [] | | `startTime` | `string` | | `succeeded` | `number` | KubeResource.status `Optional` toolbarText: `ToolbarText` KubeResource.toolbarText packages/core/mdist/models/entity.d.ts:52 `Optional` version: `string` optional designation of resource version KubeResource.version packages/core/mdist/models/entity.d.ts:39
Project: ArangoDB (App Definition and Development / Database)
File: implicit_success_move_constructor.md

+++ title = "`basicresult(successtype<T> &&)`" description = "Implicit value-from-success-type-sugar move constructor. Available if `predicate::enablecompatibleconversion<T, void, void>` is true, or `T` is `void`. Constexpr, triviality and noexcept propagating." categories = ["constructors", "implicit-constructors", "tagged-constructors"] weight = 510 +++ Implicit value-from-success-type-sugar move constructor used to disambiguate the construction of the value type. Note that if `T = void`, `valuetype` will be default constructed. Calls {{% api "void onresultmoveconstruction(T *, U &&) noexcept" %}} with `this` and `success_type<T> &&`. Requires: `predicate::enablecompatibleconversion<T, void, void>` is true, or `T` is `void`. Complexity: Same as for the `valuetype` constructor which accepts `T`, or the `valuetype` default constructor if `T` is `void`. Constexpr, triviality and noexcept of underlying operations is propagated.
Project: KubeVela (App Definition and Development / Application Definition & Image Build)
File: take-over.eg.md

```yaml apiVersion: core.oam.dev/v1beta1 kind: Application metadata: name: take-over spec: components: name: busybox type: k8s-objects properties: objects: apiVersion: apps/v1 kind: Deployment metadata: name: busybox-ref policies: type: take-over name: take-over properties: rules: selector: resourceTypes: ["Deployment"] ```
Project: KubeVela (App Definition and Development / Application Definition & Image Build)
File: k8s-update-strategy.eg.md

```yaml apiVersion: core.oam.dev/v1beta1 kind: Application metadata: name: application-with-update-strategy spec: components: name: helloworld type: webservice properties: cpu: "0.5" exposeType: ClusterIP image: oamdev/hello-world:latest memory: 1024Mi ports: expose: true port: 80 protocol: TCP traits: type: scaler properties: replicas: 5 type: k8s-update-strategy properties: targetAPIVersion: apps/v1 targetKind: Deployment strategy: type: RollingUpdate rollingStrategy: maxSurge: 20% maxUnavailable: 30% apiVersion: core.oam.dev/v1beta1 kind: Application metadata: name: application-node-exporter spec: components: name: node-exporter type: daemon properties: image: prom/node-exporter imagePullPolicy: IfNotPresent volumeMounts: hostPath: mountPath: /host/sys mountPropagation: HostToContainer name: sys path: /sys readOnly: true mountPath: /host/root mountPropagation: HostToContainer name: root path: / readOnly: true traits: properties: args: --path.sysfs=/host/sys --path.rootfs=/host/root --no-collector.wifi --no-collector.hwmon --collector.filesystem.ignored-mount-points=^/(dev|proc|sys|var/lib/docker/.+|var/lib/kubelet/pods/.+)($|/) --collector.netclass.ignored-devices=^(veth.*)$ type: command properties: annotations: prometheus.io/path: /metrics prometheus.io/port: "8080" prometheus.io/scrape: "true" port: 9100 type: expose properties: cpu: 0.1 memory: 250Mi type: resource type: k8s-update-strategy properties: targetAPIVersion: apps/v1 targetKind: DaemonSet strategy: type: RollingUpdate rollingStrategy: maxSurge: 20% maxUnavailable: 30% ```
Project: Notary (Provisioning / Security & Compliance)
File: version.md

Use `notation version` to print notation version information. Upon successful execution, the following information is printed. ```text Notation - a tool to sign and verify artifacts. Version: <MAJOR.MINOR.PATCH> Go version: go<MAJOR.MINOR.PATCH> Git commit: <long_hash> ``` ```text Show the notation version information Usage: notation version [flags] Flags: -h, --help Help for version ``` ```shell notation version ``` An example output: ```text Notation - a tool to sign and verify artifacts. Version: 1.0.0 Go Version: go1.19.2 Git commit: 1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a ```
Project: Apache Spark (App Definition and Development / Streaming & Messaging)
File: sql-ref-syntax-aux-resource-mgmt-add-archive.md

layout: global title: ADD ARCHIVE displayTitle: ADD ARCHIVE license: | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. `ADD ARCHIVE` can be used to add an archive file to the list of resources. The given archive file should be one of .zip, .tar, .tar.gz, .tgz and .jar. The added archive file can be listed using . ```sql ADD { ARCHIVE | ARCHIVES } file_name [ ... ] ``` file_name* The name of the archive file to be added. It could be either on a local file system or a distributed file system. ```sql ADD ARCHIVE /tmp/test.tar.gz; ADD ARCHIVE "/path/to/some.zip"; ADD ARCHIVE '/some/other.tgz'; ADD ARCHIVE "/path with space/abc.tar"; ADD ARCHIVES "/path with space/def.tgz" '/path with space/ghi.zip'; ```
Project: Backstage (App Definition and Development / Application Definition & Image Build)
File: index.md

This is a basic example of documentation. It is intended as a showcase of some of the features that TechDocs provides out of the box. You can see also: - Diagrams, emojis, visual formatting. Headings: Here is a bulleted list: Item one Item two Item Three Check out the to learn more about how to simply create documentation. You can also learn more about how to configure and setup this documentation in Backstage, . This documentation is powered by Backstage's TechDocs feature: While this documentation isn't comprehensive, in the future it should cover the following topics outlined in this example table: | Topic | Description | | - | | | Topic 1 | An introductory topic to help you learn about the component. | | Topic 2 | A more detailed topic that explains more information. | | Topic 3 | A final topic that provides conclusions and lessons learned. |
Project: Docker Compose (App Definition and Development / Application Definition & Image Build)
File: compose_logs.md

<!MARKERGENSTART--> View output from containers | Name | Type | Default | Description | |:|:|:--|:--| | `--dry-run` | | | Execute command in dry run mode | | `-f`, `--follow` | | | Follow log output | | `--index` | `int` | `0` | index of the container if service has multiple replicas | | `--no-color` | | | Produce monochrome output | | `--no-log-prefix` | | | Don't print prefix in logs | | `--since` | `string` | | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | | `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs for each container | | `-t`, `--timestamps` | | | Show timestamps | | `--until` | `string` | | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | <!MARKERGENEND--> Displays log output from services
Project: KubeEdge (Provisioning / Automation & Configuration)
File: edgemark_setup_guide.md

This document serves to understand how to set up edgemark cluster given that a base cluster (to run hollow-edge-node pods) and separate master (to act as master for the hollow edge nodes) are already present. You need edgemark master and external cluster to set up a edgemark cluster. The functions are as follows: edgemark master: can be StandAlone or HA, used to be the edgemark cluster's master external cluster: used to create hollow edge nodes for the edgemark cluster Deploy CloudCore in edgemark cluster, refer to for more details. Build edgemark image If you want to build/use your own edgemark image, do as follows. i. pull kubeedge code ``` cd $GOPATH/src/github.com/kubeedge git clone git@github.com:kubeedge/kubeedge.git ``` ii. build edgemark image ``` cd $GOPATH/src/github.com/kubeedge/kubeedge make image WHAT=edgemark ``` Then you can get the image named `kubeedge/edgemark:{tag}` locally. Create hollow nodes in external cluster i. create namespace and secret Copy edgemark master's `tokensecret` which is generated by CloudCore which is used to access CloudCore for edge node, and create it in namespace that will deploy hollow edge node in external cluster. first, save `tokensecret` in file from edgemark cluster, ``` kubectl get secret -nkubeedge tokensecret -oyaml > tokensecret.yaml ``` modify namespace in `tokensecret.yaml` ``` sed -i "s|namespace: .*|namespace: {ns}|g" tokensecret.yaml ``` create ns and tokensecret in external cluster ``` kubectl create ns edgemark kubectl create -f tokensecret.yaml ``` ii. apply yaml to create hollow nodes You can use `hollow-edge-node_template.yaml` in the current directory. Note: the parameters `{{numreplicas}}` means the number of hollow nodes in the edgemark cluster the parameters `{{server}}` means the server address exposed for hollow nodes join in the parameters `{{server}}`, `{{numreplicas}}`, `{{edgemarkimageregistry}}` and `{{edgemarkimagetag}}` need to be filled in the template your external cluster should have enough resources to be able to run `{{numreplicas}}` no. of hollow-node pods ``` kubectl create -f hollow-edge-node_template.yaml ``` Waiting for these hollow-node pods to be running. Then you can see these pods register as edgemark master's nodes. Finally, edgemark master and external cluster set up the edgemark cluster. Run performance testing with ClusterLoader2 After set up the edgemark cluster, we can do our performance testing with ClusterLoader2. is an official K8s scalability and performance testing framework. refer to for more details. we just need config `--provider=kubemark` when we run performance test, for example: ``` ./clusterloader --testconfig=config.yaml --provider=kubemark --kubeconfig=${HOME}/.kube/config --v=2 ```
Project: Apache Hadoop (App Definition and Development / Database)
File: BuildingIt.md

<! Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. See accompanying LICENSE file. --> Hadoop Auth, Java HTTP SPNEGO - Building It =========================================== Requirements Java 7+ Maven 3+ Kerberos KDC (for running Kerberos test cases) Building -- Use Maven goals: clean, test, compile, package, install Available profiles: docs, testKerberos Testing By default Kerberos testcases are not run. The requirements to run Kerberos testcases are a running KDC, a keytab file with a client principal and a kerberos principal. To run Kerberos tescases use the `testKerberos` Maven profile: $ mvn test -PtestKerberos The following Maven `-D` options can be used to change the default values: `hadoop-auth.test.kerberos.realm`: default value LOCALHOST* `hadoop-auth.test.kerberos.client.principal`: default value client* `hadoop-auth.test.kerberos.server.principal`: default value HTTP/localhost* (it must start 'HTTP/') `hadoop-auth.test.kerberos.keytab.file`: default value $HOME/$USER.keytab* To create the documentation use the `docs` Maven profile: $ mvn package -Pdocs The generated documentation is available at `hadoop-auth/target/site/`.