cwielenb/CNCF-Dataset huggingface dataset:
Project: Longhorn (Runtime / Cloud Native Storage)
File: feature.md

name: Feature request about: Suggest an idea/feature title: "[FEATURE] " labels: ["kind/feature", "require/lep", "require/doc", "require/auto-e2e-test", "require/manual-test-plan"] assignees: '' <!--A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]--> <!--A clear and concise description of what you want to happen--> <!--A clear and concise description of any alternative solutions or features you've considered.--> <!--Add any other context or screenshots about the feature request here.-->
Project: Soda Foundation (Runtime / Cloud Native Storage)
File: nbp.md

The SUSHI Project is an umbrella project for all the NorthBound Plugins, for OpenStack, Kubernetes, Mesos, VMware and more. The plugins themselves could have multiple hosting location, however the OpenSDS Sushi Project repo should always have the most up-to-date version. Sushi will also seek to collaborate with other upstream open source communities such as Cloud Native Computing Foundation, Docker, OpenStack, and Open Container Initiative. The OpenSDS community welcomes anyone who is interested in software defined storage and shaping the future of cloud-era storage. If you are a company, you should consider joining the . If you are a developer want to be part of the code development that is happening now, please refer to the Contributing sections below. Mailing list: slack: # Ideas/Bugs:
Project: Multus (Runtime / Cloud Native Network)
File: development.md

Currently multus team supports Kubernetes that Kubernetes community maintains. See for the details. Latest multus uses container image for its base, hence there is no shell command. If you want to execute shell in multus pod, please use `-debug` image (e.g. ghcr.io/k8snetworkplumbingwg/multus-cni:snapshot-debug), which has shell. Multus now uses to expose its code as library. You can use following command to import our code into your go code. ``` go get gopkg.in/k8snetworkplumbingwg/multus-cni.v4 ``` Use GitHub as normally, you'll be presented with an option to submit a issue or enhancement request. Issues are considered stale after 90 days. After which, the maintainers reserve the right to close an issue. Typically, we'll tag the submitter and ask for more information if necessary before closing. If an issue is closed that you don't feel is sufficiently resolved, please feel free to re-open the issue and provide any necessary information. You can use the built in `./hack/build-go.sh` script! ``` git clone https://github.com/k8snetworkplumbingwg/multus-cni.git cd multus-cni ./hack/build-go.sh ``` Multus has go unit tests (based on ginkgo framework).The following commands drive CI tests manually in your environment: ``` sudo ./hack/test-go.sh ``` The following are the best practices for multus logging: Add `logging.Debugf()` at the beginning of functions In case of error handling, use `logging.Errorf()` with given error info `logging.Panicf()` only be used for critical errors (it should NOT normally be used) On the first maintainer's meeting, twice yearly, after January 1st and July 1st, if a new version has not been tagged, a new version will tagged.
Project: Weave Net (Runtime / Cloud Native Network)
File: RELEASE.md

The `yaml` Project is released on an as-needed basis. The process is as follows: An issue is proposing a new release with a changelog since the last release All must LGTM this release An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION` The release issue is closed An announcement email is sent to `kubernetes-dev@googlegroups.com` with the subject `[ANNOUNCE] kubernetes-template-project $VERSION is released`
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_service_delete.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Delete a service ``` cilium-dbg service delete { <service id> | --all } [flags] ``` ``` --all Delete all services -h, --help help for delete ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - Manage services & loadbalancers
Project: rkt (Runtime / Container Runtime)
File: production-users.md

This document tracks people and use cases for rkt in production. , and help us keep the list up-to-date. BlaBlaCar is a trusted car-pooling service based in France. They've the stability of rkt being a big appeal. Media report from : "rkt has become the container technology of choice for the French carpool specialist Blablacar. The company, which has adopted early container technologies, now relies on rkt and CoreOS for 90% of its applications." Media report from , "Rocket tackled the limitations we had identified with Docker. In particular, the solution eliminated the use of a daemon (process running in the background, Editor's note) and approached the network part in a very modular way" rkt is used by Container Linux to execute the Kubernetes on node agent called the "kubelet". This enables users to be able to have cluster controlled versioning of this critical component. There are many documented production users of Kubernetes and Container Linux including all of the users of . Kumulus Technologies offers classes and services to optimize your Cloud. They've rkt's pod native features and Kubernetes support being a reason for their adoption. Kinvolk are a professional consulting team and active contributors to systemd, rkt, and the Linux kernel. rkt helps them easily . Per Milosz Tanski, . "The same experiences we switched to using rkt, supervised by upstart (and now systemd). We have an "application" state template in our salt config and every docker update something would cause all of them to fail. Thankful the "application" state template abstracted running container enough were we switched from docker -> rkt under the covers without anybody noticing, except now we no longer fearing of container software updates." These are blog posts and stories from people evaluating rkt. Although most aren't (yet) production use cases, the links offer useful information and shared experience in deploying rkt. moving from docker to rkt using rkt and systemd what happens when you run a rkt container writing his thesis on the security model of rkt a beginners guide to rkt containers rkt support is on the roadmap. See docker vs rkt comparison getting started with containers rkt overview of the rkt container engine
Project: Kata Containers (Runtime / Container Runtime)
File: ReceiveMigrationData.md

Name | Type | Description | Notes | - | - | - ReceiverUrl | string | | `func NewReceiveMigrationData(receiverUrl string, ) *ReceiveMigrationData` NewReceiveMigrationData instantiates a new ReceiveMigrationData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed `func NewReceiveMigrationDataWithDefaults() *ReceiveMigrationData` NewReceiveMigrationDataWithDefaults instantiates a new ReceiveMigrationData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set `func (o *ReceiveMigrationData) GetReceiverUrl() string` GetReceiverUrl returns the ReceiverUrl field if non-nil, zero value otherwise. `func (o ReceiveMigrationData) GetReceiverUrlOk() (string, bool)` GetReceiverUrlOk returns a tuple with the ReceiverUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *ReceiveMigrationData) SetReceiverUrl(v string)` SetReceiverUrl sets ReceiverUrl field to given value.
Project: Cilium (Runtime / Cloud Native Network)
File: TROUBLESHOOTING.md

The most common reason for this issue is improper use of struct tags (eg. `yaml` or `json`). Viper uses under the hood for unmarshaling values which uses `mapstructure` tags by default. Please refer to the library's documentation for using other struct tags. Viper installation seems to fail a lot lately with the following (or a similar) error: ``` cannot find package "github.com/hashicorp/hcl/tree/hcl1" in any of: /usr/local/Cellar/go/1.15.7_1/libexec/src/github.com/hashicorp/hcl/tree/hcl1 (from $GOROOT) /Users/user/go/src/github.com/hashicorp/hcl/tree/hcl1 (from $GOPATH) ``` As the error message suggests, Go tries to look up dependencies in `GOPATH` mode (as it's commonly called) from the `GOPATH`. Viper opted to use to manage its dependencies. While in many cases the two methods are interchangeable, once a dependency releases new (major) versions, `GOPATH` mode is no longer able to decide which version to use, so it'll either use one that's already present or pick a version (usually the `master` branch). The solution is easy: switch to using Go Modules. Please refer to the on how to do that. tl;dr* `export GO111MODULE=on` This is a YAML 1.1 feature according to . Potential solutions are: Quoting values resolved as boolean Upgrading to YAML v3 (for the time being this is possible by passing the `viper_yaml3` tag to your build)
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-operator-generic_completion_zsh.md

<!-- This file was autogenerated via cilium-operator --cmdref, do not edit manually--> Generate the autocompletion script for zsh Generate the autocompletion script for the zsh shell. If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once: echo "autoload -U compinit; compinit" >> ~/.zshrc To load completions in your current shell session: source <(cilium-operator-generic completion zsh) To load completions for every new session, execute once: cilium-operator-generic completion zsh > "${fpath[1]}/_cilium-operator-generic" cilium-operator-generic completion zsh > $(brew --prefix)/share/zsh/site-functions/_cilium-operator-generic You will need to start a new shell for this setup to take effect. ``` cilium-operator-generic completion zsh [flags] ``` ``` -h, --help help for zsh --no-descriptions disable completion descriptions ``` - Generate the autocompletion script for the specified shell
Project: CRI-O (Runtime / Container Runtime)
File: CONTRIBUTING.md

Welcome to Kubernetes. We are excited about the prospect of you joining our ! The Kubernetes community abides by the CNCF . Here is an excerpt: As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. This library adapts the stdlib `encoding/json` decoder to be compatible with Kubernetes JSON decoding, and is not expected to actively add new features. It may be updated with changes from the stdlib `encoding/json` decoder. Any code that is added must: Have full unit test and benchmark coverage Be backward compatible with the existing exposed go API Have zero external dependencies Preserve existing benchmark performance Preserve compatibility with existing decoding behavior of `UnmarshalCaseSensitivePreserveInts()` or `UnmarshalStrict()` Avoid use of `unsafe` We have full documentation on how to get started contributing here: <! If your repo has certain guidelines for contribution, put them here ahead of the general k8s resources --> Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests - Main contributor documentation, or you can just jump directly to the - Common resources for existing developers You can reach the maintainers of this project via the . - We have a diverse set of mentorship programs available that are always looking for volunteers!
Project: Velero (Runtime / Cloud Native Storage)
File: README-HUGO.md

To run this site in a Docker container, you can use `make serve-docs` from the root directory. Install the following for an easy to use dev environment: `brew install hugo` If you are running a build on Ubuntu you will need the following packages: hugo Clone down your own fork, or clone the main repo `git clone https://github.com/vmware-tanzu/velero` and add your own remote. `cd velero/site` Serve the site and watch for markup/sass changes `hugo serve`. View your website at http://127.0.0.1:1313/ Commit any changes and push everything to your fork. Once you're ready, submit a PR of your changes. Netlify will automatically generate a preview of your changes. Install the `Hugo Integration` plugin: https://plugins.jetbrains.com/plugin/13215-hugo-integration Under `Preferences...` -> `Plugins` Create a new configuration: Click `Edit Configurations...` Click the `+` button to create a new configuration and select `Hugo` Select `hugo serve` and make sure it is running under the `site` directory Save and run the new Configuration View your website at http://127.0.0.1:1313/ Any changes in `site` will reload the website automatically To add a new set of versioned docs to go with a new Velero release: In the root of the repository, run: ```bash NEWDOCSVERSION=vX.Y VELERO_VERSION=vX.Y.Z make gen-docs ``` [Pre-release only] In `site/config.yaml`, revert the change to the `latest` field, so the pre-release docs do not become the default.
Project: Antrea (Runtime / Cloud Native Network)
File: cherry-picks.md

Some Pull Requests (PRs) which fix bugs in the main branch of Antrea can be identified as good candidates for backporting to currently maintained release branches (using a Git ), so that they can be included in subsequent patch releases. If you have authored such a PR (thank you!!!), one of the Antrea maintainers may comment on your PR to ask for your assistance with that process. This document provides the steps you can use to cherry-pick your change to one or more release branches, with the help of the . For information about which changes are good candidates for cherry-picking, please refer to our [versioning policy](../versioning.md#minor-releases-and-patch-releases). A PR which was approved and merged into the main branch. The PR was identified as a good candidate for backporting by an Antrea maintainer: they will label the PR with `action/backport` and comment a list of release branches to which the patch should be backported (example: ). Have the installed (version >= 1.3) and make sure you authenticate yourself by running `gh auth`. Your own fork of the Antrea repository, and a clone of this fork with two remotes: the `origin` remote tracking your fork and the `upstream` remote tracking the upstream Antrea repository. If you followed our recommended [Github Workflow], this should already be the case. Set the GITHUB_USER environment variable. Optional If your remote names do not match our recommended [Github Workflow], you must set the `UPSTREAMREMOTE` and `FORKREMOTE` environment variables. Run the This example applies a main branch PR #2134 to the remote branch `upstream/release-1.0`: ```shell hack/cherry-pick-pull.sh upstream/release-1.0 2134 ``` If the cherry-picked PR does not apply cleanly against an old release branch, the script will let you resolve conflicts manually. This is one of the reasons why we ask contributors to backport their own bug fixes, as their participation is critical in case of such a conflict. The script will create a PR on Github for you, which will automatically be labelled with `kind/cherry-pick`. This PR will go through the normal testing process, although it should be very quick given that the original PR was already approved and merged into the main branch. The PR should also go through normal CI testing. In some cases, a few CI tests may fail because we do not have dedicated CI infrastructure for past Antrea releases. If this happens, the PR will be merged despite the presence of CI test failures. You will need to run the cherry pick script separately for each release branch you need to cherry-pick to. Typically, cherry-picks should be applied to all release branches for which the fix is applicable.
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_kvstore.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Direct access to the kvstore ``` -h, --help help for kvstore --kvstore string Key-Value Store type --kvstore-opt map Key-Value Store options ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - CLI - Delete a key - Retrieve a key - Set a key and value
Project: Kata Containers (Runtime / Container Runtime)
File: how-to-setup-swap-devices-in-guest-kernel.md

Setup swap device in guest kernel can help to increase memory capacity, handle some memory issues and increase file access speed sometimes. Kata Containers can insert a raw file to the guest as the swap device. The swap config of the containers should be set by . So . Kata Containers just supports setup swap device in guest kernel with QEMU. Install and setup Kata Containers as shown . Enable setup swap device in guest kernel as follows: ``` $ sudo sed -i -e 's/^#enableguestswap.*$/enableguestswap = true/g' /etc/kata-containers/configuration.toml ``` Use following command to start a Kata Containers with swappiness 60 and 1GB swap device (swapinbytes - memorylimitin_bytes). ``` $ pod_yaml=pod.yaml $ container_yaml=container.yaml $ image="quay.io/prometheus/busybox:latest" $ cat << EOF > "${pod_yaml}" metadata: name: busybox-sandbox1 uid: $(uuidgen) namespace: default EOF $ cat << EOF > "${container_yaml}" metadata: name: busybox-test-swap annotations: io.katacontainers.container.resource.swappiness: "60" io.katacontainers.container.resource.swapinbytes: "2147483648" linux: resources: memorylimitin_bytes: 1073741824 image: image: "$image" command: top EOF $ sudo crictl pull $image $ podid=$(sudo crictl runp --runtime kata $pod_yaml) $ cid=$(sudo crictl create $podid $containeryaml $podyaml) $ sudo crictl start $cid ``` Kata Containers setups swap device for this container only when `io.katacontainers.container.resource.swappiness` is set. The following table shows the swap size how to decide if `io.katacontainers.container.resource.swappiness` is set. |`io.katacontainers.container.resource.swapinbytes`|`memorylimitin_bytes`|swap size| |||| |set|set| `io.katacontainers.container.resource.swapinbytes` - `memorylimitin_bytes`| |not set|set| `memorylimitin_bytes`| |not set|not set| `io.katacontainers.config.hypervisor.default_memory`| |set|not set|cgroup doesn't support this usage|
Project: Velero (Runtime / Cloud Native Storage)
File: ark_restore_describe.md

title: "ark restore describe" layout: docs Describe restores Describe restores ``` ark restore describe [NAME1] [NAME2] [NAME...] [flags] ``` ``` -h, --help help for describe -l, --selector string only show items matching this label selector --volume-details display details of restic volume restores ``` ``` --alsologtostderr log to standard error as well as files --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) --logbacktraceat traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --logtostderr log to standard error instead of files -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") --stderrthreshold severity logs at or above this threshold go to stderr (default 2) -v, --v Level log level for V logs --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` - Work with restores
Project: Stash by AppsCode (Runtime / Cloud Native Storage)
File: LICENSE.md

MIT License Copyright (c) 2019 Josh Bleecher Snyder 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 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: Velero (Runtime / Cloud Native Storage)
File: ark_describe_schedules.md

title: "ark describe schedules" layout: docs Describe schedules Describe schedules ``` ark describe schedules [NAME1] [NAME2] [NAME...] [flags] ``` ``` -h, --help help for schedules -l, --selector string only show items matching this label selector ``` ``` --alsologtostderr log to standard error as well as files --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) --logbacktraceat traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --logtostderr log to standard error instead of files -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") --stderrthreshold severity logs at or above this threshold go to stderr (default 2) -v, --v Level log level for V logs --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` - Describe ark resources
Project: OpenEBS (Runtime / Cloud Native Storage)
File: helm.md

A Helm chart that collects CustomResourceDefinitions (CRDs) from OpenEBS. | Key | Type | Default | Description | |--|||-| | csi.volumeSnapshots.enabled | bool | `true` | Install Volume Snapshot CRDs | | csi.volumeSnapshots.keep | bool | `true` | Keep CRDs on chart uninstall |
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_service.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Manage services & loadbalancers ``` -h, --help help for service ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - CLI - Delete a service - Display service information - List services - Update a service
Project: Sysbox (Runtime / Container Runtime)
File: install.md

The method of installation for Sysbox depends on the environment where Sysbox will be installed: - If a package for your distro is not yet available, or if you want to get the latest changes from upstream. NOTE: See the for the list of Linux distros where Sysbox is supported and the installation methods supported for each. Also, see the for the list of supported machine architectures (e.g., amd64, arm64).