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

In order for any software to be reliable enough for production use, it needs to have a stable API. This means that users would have a high confidence that the way they use Kubevirt would not become obsolete, or at least would give the proper time to prepare if it does. This document aims to specify a process for several aspects of deprecation revolving Kubevirt. This is intended to be a "live document" which updates and refines itself over time. A feature gate should be introduced for every new feature, capability, configuration or any other change that is not yet stable and can jeopardize the cluster. A feature gate serves as: A way to warn the user about a possible danger that could be caused by an unstable logic. A way for the users to explicitly state that they would like to take the risk and enable the feature. A way for the user to explicitly confirm that some feature / HW is available on the cluster. Over time the new features would stabilize and graduate their API versions (i.e. from alpha, to beta to stable). When that happens, and therefore the risk of jeopardizing the user decreases significantly, the feature should be enabled by default and the feature gate should be deprecated (see section below). A feature gate should be deprecated for one of the following reasons: When a feature stabilizes and there is no need to guard it by a feature gate. When a feature (that's guarded with a feature gate) did not show as useful, therefore is deprecated. In order to deprecate a feature gate the following conditions must be met: All the features that used to be guarded by it need to be enabled by default. The above point means that all of the features that were guarded by this feature gate would be enabled without the need to enable this feature gate. In other words, the feature gate needs to turn into a no-op. When the feature gate is enabled (by creating / updating Kubevit CR), a warning should be presented to the user. The best fit to trigger the warning is probably our validating webhooks. A mail should be sent to kubevirt-dev mailing list (kubevirt-dev@googlegroups.com) to inform about the deprecation. After the above deprecation process, the feature gate should remain as a no-op with a warning popping up. An ongoing discussion takes part in the following issue: https://github.com/kubevirt/kubevirt/issues/7745
Project: KOTS (App Definition and Development / Application Definition & Image Build)
File: gitops-cluster-tracers.md

KOTS (Admin Console) does not have the ability to detect the currently deployed application version in a GitOps cluster workflow. This proposal adds tracers (annotations) to the application pods so that it can be possible to detect that in the future. Add annotations to application pods to help detect deployments in GitOps clusters in the future Detect the currently deployed application version in a GitOps cluster When customers decide to deploy their application via a GitOps workflow, they will probably want to know which version of the app is currently deployed in the cluster, which is currently not possible. Add annotations for both the application slug and sequence to all of the application pods via Kustomize. Those annotations will be applied to the downstream manifests before commiting the new changes. When (re)writing the midstream in KOTS, the following will be injected into the kustomization.yaml file: ``` commonAnnotations: kots.io/app-slug: <app-slug> kots.io/app-sequence: <app-sequence> ``` both the `<app-slug>` & `<app-sequence>` will be added to the pull/rewrite options before calling kots.pull or kots.rewrite from the KOTS Admin Console. The rest of the logic is already implemented. Before creating new commits, `kustomize build` is executed to apply those changes to the downstream manifests.
Project: Artifact Hub (App Definition and Development / Application Definition & Image Build)
File: embedding_artifacts.md

Artifact Hub allows embedding a single artifact or a group of them in other websites. You can embed an Artifact Hub package on other websites by adding the corresponding embed code. The embed code is a piece of HTML that can be generated from the Artifact Hub UI. Let's go through an example to see how this works. The first step is to find the package you'd like to embed on <https://artifacthub.io>. For this example, we'll use the . On the top right corner of the package view you'll see a button with three dots. If you click on it, you'll see an entry named `Embed widget`, which opens the widget configurator. From it you can customize the widget's appearance to suit your needs. Once you are done, you can copy the resulting embed code by clicking on `copy code to clipboard` at the bottom. The generated code would be something like this: ```html <div class="artifacthub-widget" data-url="https://artifacthub.io/packages/helm/artifact-hub/artifact-hub" data-theme="light" data-header="true" data-stars="true" data-responsive="false" <blockquote> <p lang="en" dir="ltr"><b>artifact-hub</b>: Artifact Hub is a web-based application that enables finding, installing, and publishing Cloud Native packages.</p> &mdash; Open in <a href="https://artifacthub.io/packages/helm/artifact-hub/artifact-hub">Artifact Hub</a> </blockquote> </div> <script async src="https://artifacthub.io/artifacthub-widget.js"></script> ``` To verify it works as expected, you can give it a quick try on JSFiddle if you'd like: <https://jsfiddle.net/r0ox4c9a/>. Embedding a group of artifacts is very similar to embedding a single one. The main difference is that, instead of opening the widget configurator from the package view, it is opened from the search results view. This allows you to use all the search filters available to select what packages you'd like to embed on the other website. You could choose all packages of a given kind, those published by a given organization or all packages provided by CNCF projects, for example. Then, from the configurator, you can customize the appearance of the widgets like we did on the previous case with a single artifact. Once you are ready to go, you can copy the embed code and add it to the website you'd like to embed the artifacts on. You can see a widgets group in action in .
Project: Harbor (Provisioning / Container Registry)
File: 11-03-add-labels-to-images-and-remove-labels-from-images.md

Test 11-03 - Add/remove labels to/from images ======= To verify that the users whose role >= project developer can add/remove labels to/from images. User guide This test requires that a Harbor instance is running and available. At least one global level label and one project level label are created. The project developer user logs in to the UI. The user add a global level label to an image from the UI. The user add a project level label to an image from the UI. The user removes the global label from the image. The user removes the project label from the image. Login in to the UI as a project admin user and repeat the Step2-5. Login in to the UI as a system admin user and repeat the Step2-5. Login in to the UI as a project guest user and try to add a label to an image. In Step2, the global level label can be added to the image successfully. In Step3, the project level label can be added to the image successfully. In Step4, the global level label can be removed from the image successfully. In Step5, the project level label can be removed from the image successfully. In Step6, the project admin user can do the same operations as the project developer user. In Step7, the system admin user can do the same operations as the project developer user. In Step8, the project guest user can not add a label to an image. None
Project: KubeVela (App Definition and Development / Application Definition & Image Build)
File: webservice.eg.md

```yaml apiVersion: core.oam.dev/v1beta1 kind: Application metadata: name: website spec: components: name: frontend type: webservice properties: image: oamdev/testapp:v1 cmd: ["node", "server.js"] ports: port: 8080 expose: true cpu: "0.1" env: name: FOO value: bar name: FOO valueFrom: secretKeyRef: name: bar key: bar ```
Project: DevSpace (App Definition and Development / Application Definition & Image Build)
File: devspace_remove_port.md

title: "Command - devspace remove port" sidebar_label: devspace remove port Removes forwarded ports from a devspace ``` devspace remove port [flags] ``` ``` Removes port mappings from the devspace configuration: devspace remove port 8080,3000 devspace remove port --label-selector=release=test devspace remove port --all ``` ``` --all Remove all configured ports -h, --help help for port --label-selector string Comma separated key=value selector list (e.g. release=test) ``` ``` --config string The devspace config file to use --debug Prints the stack trace if an error occurs --kube-context string The kubernetes context to use -n, --namespace string The kubernetes namespace to use --no-warn If true does not show any warning when deploying into a different namespace or kube-context than before -p, --profile string The devspace profile to use (if there is any) --silent Run in silent mode and prevents any devspace log output except panics & fatals -s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project --var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE) ```
Project: Helm (App Definition and Development / Application Definition & Image Build)
File: pull_request_template.md

<!-- Thanks for sending a pull request! Here are some tips for you: Make sure to read the Contributing Guide before submitting your PR: https://github.com/helm/helm/blob/main/CONTRIBUTING.md If this PR closes another issue, add 'closes #<issue number>' somewhere in the PR summary. GitHub will automatically close that issue when this PR gets merged. Alternatively, adding 'refs #<issue number>' will not close the issue, but help provide the reviewer more context.--> What this PR does / why we need it: Special notes for your reviewer: If applicable: [ ] this PR contains documentation [ ] this PR contains unit tests [ ] this PR has been tested for backwards compatibility
Project: KICS (Provisioning / Security & Compliance)
File: 0a96ce49-4163-4ee6-8169-eb3b0797d694.md

title: API Gateway Without Configured Authorizer hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 0a96ce49-4163-4ee6-8169-eb3b0797d694 Query name: API Gateway Without Configured Authorizer Platform: Terraform Severity: <span style="color:#ff7213">Medium</span> Category: Access Control URL: API Gateway REST API should have an API Gateway Authorizer<br> ```tf title="Positive test num. 1 - tf file" hl_lines="8" resource "awsapigateway_authorizer" "demo" { name = "demo" restapiid = awsapigatewayrestapi.demo.id authorizeruri = awslambdafunction.authorizer.invokearn authorizercredentials = awsiamrole.invocationrole.arn } resource "awsapigatewayrestapi" "demo2" { name = "auth-demo" } ``` ```tf title="Negative test num. 1 - tf file" resource "awsapigateway_authorizer" "demo" { name = "demo" restapiid = awsapigatewayrestapi.demo.id authorizeruri = awslambdafunction.authorizer.invokearn authorizercredentials = awsiamrole.invocationrole.arn } resource "awsapigatewayrestapi" "demo" { name = "auth-demo" } ```
Project: Chef InSpec (Provisioning / Security & Compliance)
File: google_pubsub_subscription_iam_binding.md

+++ title = "googlepubsubsubscriptioniambinding resource" draft = false gh_repo = "inspec" platform = "gcp" [menu] [menu.inspec] title = "googlepubsubsubscriptioniambinding" identifier = "inspec/resources/gcp/googlepubsubsubscriptioniambinding.md googlepubsubsubscriptioniambinding resource" parent = "inspec/resources/gcp" +++ A `googlepubsubsubscriptioniambinding` is used to test a Google Subscription Iam Bindings ```ruby describe googlepubsubsubscriptioniambinding(project: "project", name: "name", role: "roles/editor") do it { should exist } its('members') { should include 'user:testuser@example.com' } end ``` Properties that can be accessed from the `googlepubsubsubscriptioniambinding` resource: `role` : Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. `members` : Specifies the identities requesting access for a Cloud Platform resource. Ensure the is enabled for the current project.
Project: Meshery (Provisioning / Automation & Configuration)
File: mesheryctl-perf-profile.md

layout: default title: mesheryctl-perf-profile permalink: reference/mesheryctl/perf/profile redirect_from: reference/mesheryctl/perf/profile/ type: reference display-title: "false" language: en command: perf subcommand: profile List performance profiles List all the available performance profiles <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl perf profile [profile-name] [flags] </div> </pre> List performance profiles (maximum 25 profiles) <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl perf profile </div> </pre> List performance profiles with search (maximum 25 profiles) <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl perf profile test 2 </div> </pre> View single performance profile with detailed information <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl perf profile test --view </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> -h, --help help for profile -p, --page int (optional) List next set of performance results with --page (default = 1) (default 1) --view (optional) View single performance profile with more info </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> --config string path to config file (default "/home/runner/.meshery/config.yaml") -o, --output-format string (optional) format to display in [json|yaml] -t, --token string (required) Path to meshery auth config -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: Apache Hadoop (App Definition and Development / Database)
File: RELEASENOTES.0.23.3.md

<! --> These release notes cover new developer and user-facing incompatibilities, important issues, features, and major improvements. | Major | mapred job -status fails to give info even if the job is present in History* Fixed a bug in MR client to redirect to JobHistoryServer correctly when RM forgets the app. | Major | User set java.library.path seems to overwrite default creating problems native lib loading* -Djava.library.path in mapred.child.java.opts can cause issues with native libraries. LD\LIBRARY\PATH through mapred.child.env should be used instead. | Trivial | Add jobname to jobsummary log* The Job Summary log may contain commas in values that are escaped by a '\\' character. This was true before, but is more likely to be exposed now. | Major | Lower default allocation sizes, fix allocation configurations and document them* Removes two sets of previously available config properties: ( yarn.scheduler.fifo.minimum-allocation-mb and yarn.scheduler.fifo.maximum-allocation-mb ) and, ( yarn.scheduler.capacity.minimum-allocation-mb and yarn.scheduler.capacity.maximum-allocation-mb ) In favor of two new, generically named properties: yarn.scheduler.minimum-allocation-mb - This acts as the floor value of memory resource requests for containers. yarn.scheduler.maximum-allocation-mb - This acts as the ceiling value of memory resource requests for containers. Both these properties need to be set at the ResourceManager (RM) to take effect, as the RM is where the scheduler resides. Also changes the default minimum and maximums to 128 MB and 10 GB respectively. | Blocker | Hftp hangs on transfers \>2GB* WARNING: No release note provided for this change. | Major | distcpv2 and distcpv1 jars should not coexist* Resolve sporadic distcp issue due to having two DistCp classes (v1 & v2) in the classpath. | Critical | Mavenize Gridmix.* Note that to apply this you should first run the script - ./MAPREDUCE-3543v3.sh svn, then apply the patch. If this is merged to more then trunk, the version inside of hadoop-tools/hadoop-gridmix/pom.xml will need to be udpated accordingly. | Major | Capacity scheduler.xml does not accept decimal values for capacity and maximum-capacity settings* WARNING: No release note provided for this change. | Major | ContainerTokens should have an expiry interval* ContainerTokens now have an expiry interval so that stale tokens cannot be used for launching containers. | Major | fs -mkdir creates parent directories without the -p option* FsShell's "mkdir" no longer implicitly creates all non-existent parent directories. The command adopts the posix compliant behavior of requiring the "-p" flag to auto-create parent directories. | Major | distcpV2: turn CRC checking off for 0 byte size* distcp skips CRC on 0 byte files.
Project: Meshery (Provisioning / Automation & Configuration)
File: cpx.md

layout: integration title: Citrix Service Mesh subtitle: The easiest way to get a production-grade Kubernetes cluster up and running image: /assets/img/integrations/cpx/icons/color/cpx-color.svg permalink: extensibility/integrations/cpx docURL: https://docs.meshery.io/extensibility/adapters/cpx description: integrations-category: Cloud Native Network integrations-subcategory: Service Mesh registrant: Artifact Hub components: featureList: [ "Enable and enforce mutual TLS between your clusters", "Analyze Istio Destination Rules", "Design Istio Virtual Services" ] howItWorks: "Collaborative Infrastructure as Code" howItWorksDetails: "Collaboratively manage infrastructure with your coworkers synchronously sharing the same designs." language: en list: include type: extensibility category: integrations
Project: YDB (App Definition and Development / Database)
File: LICENSE.md

MIT License Copyright (c) 1998 Massachusetts Institute of Technology Copyright (c) 2007 - 2023 Daniel Stenberg with many contributors, see AUTHORS file. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project: KubeVela (App Definition and Development / Application Definition & Image Build)
File: create-config.eg.md

```yaml kind: Application apiVersion: core.oam.dev/v1beta1 metadata: name: test-config namespace: "config-e2e-test" spec: components: [] workflow: steps: name: write-config type: create-config properties: name: test config: key1: value1 key2: 2 key3: true key4: key5: value5 name: read-config type: read-config properties: name: test outputs: fromKey: config name: read-config name: delete-config type: delete-config properties: name: test ```
Project: YugabyteDB (App Definition and Development / Database)
File: pgadmin.md

title: Use pgAdmin with YugabyteDB YSQL headerTitle: pgAdmin linkTitle: pgAdmin description: Administer and manage YugabyteDB distributed SQL databases using pgAdmin. menu: v2.18: identifier: pgadmin parent: tools weight: 10 type: docs is a popular open source administration and management tool for PostgreSQL databases. It simplifies the creation, maintenance, and use of database objects. PgAdmin includes a connection wizard, built-in SQL editor to import SQL scripts, and a mechanism to auto-generate SQL scripts if you need to run them on the database command line shell. You can run PgAdmin through the web interface, or as a downloadable application that is locally installed. Because YugabyteDB is PostgreSQL-compatible, you can also use pgAdmin to work with YugabyteDB. To use pgAdmin with YugabyteDB, you need to have YugabyteDB up and running, the required Java Runtime Environment, and the required PostgreSQL JDBC driver. Your YugabyteDB cluster should be up and running. Refer to . To connect pgAdmin to a YugabyteDB cluster, you need the PostgreSQL JDBC driver installed. To download the current version that supports Java 8 or later, go to the page. To install pgAdmin, go to the and select the version of pgAdmin 4 for your operating system. Add a pgAdmin server to connect to a cluster as follows: Launch the pgAdmin 4 application. You are prompted to save a master password for the application. Under Quick Links, click Add New Server to display the Register - Server window. On the General tab, enter a name for your server, such as YBManaged. On the Connection tab, fill in the . For YugabyteDB Managed clusters, on the SSL tab, set Root certificate to the cluster root certificate you downloaded. Click Save. The new connection appears in the application. Expand Databases to see a list of all available databases. You can begin exploring YugabyteDB databases. For details on using pgAdmin, click Help in the pgAdmin menu. If you're looking for sample databases to explore YugabyteDB using pgAdmin, refer to .