cwielenb/CNCF-Dataset huggingface dataset:
Project: Kata Containers (Runtime / Container Runtime)
File: VmSnapshotConfig.md

Name | Type | Description | Notes | - | - | - DestinationUrl | Pointer to string | | [optional] `func NewVmSnapshotConfig() *VmSnapshotConfig` NewVmSnapshotConfig instantiates a new VmSnapshotConfig 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 NewVmSnapshotConfigWithDefaults() *VmSnapshotConfig` NewVmSnapshotConfigWithDefaults instantiates a new VmSnapshotConfig 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 *VmSnapshotConfig) GetDestinationUrl() string` GetDestinationUrl returns the DestinationUrl field if non-nil, zero value otherwise. `func (o VmSnapshotConfig) GetDestinationUrlOk() (string, bool)` GetDestinationUrlOk returns a tuple with the DestinationUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *VmSnapshotConfig) SetDestinationUrl(v string)` SetDestinationUrl sets DestinationUrl field to given value. `func (o *VmSnapshotConfig) HasDestinationUrl() bool` HasDestinationUrl returns a boolean if a field has been set.
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-health_status.md

<!-- This file was autogenerated via cilium-agent --cmdref, do not edit manually--> Display cilium connectivity to other nodes ``` cilium-health status [flags] ``` ``` -h, --help help for status -o, --output string json| yaml| jsonpath='{}' --probe Synchronously probe connectivity status --succinct Print the result succinctly (one node per line) --verbose Print more information in results ``` ``` -D, --debug Enable debug messages -H, --host string URI to cilium-health server API --log-driver strings Logging endpoints to use for example syslog --log-opt map Log driver options for cilium-health e.g. syslog.level=info,syslog.facility=local5,syslog.tag=cilium-agent ``` - Cilium Health Client
Project: Velero (Runtime / Cloud Native Storage)
File: ark_client_config_get.md

title: "ark client config get" layout: docs Get client configuration file values Get client configuration file values ``` ark client config get [KEY 1] [KEY 2] [...] [flags] ``` ``` -h, --help help for get ``` ``` --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 ``` - Get and set client configuration file values
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_bpf_tunnel.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Tunnel endpoint map ``` -h, --help help for tunnel ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - Direct access to local BPF maps - List tunnel endpoint entries
Project: CubeFS (Runtime / Cloud Native Storage)
File: plan.md

This document describes the versions supported by the CubeFS project. Service versioning and supported versions CubeFS versions are expressed as x.y.z, where x is the major version, y is the minor version, and z is the patch version, following Semantic Versioning terminology. New minor versions may add additional features to the API. The CubeFS project maintains release branches for the current version and previous release. For example, when v3.3. is the current version, v3.1. is supported. When v3.4. is released, v3.1. goes out of support. The project Maintainers own this decision.
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_bpf_metrics_list.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> List BPF datapath traffic metrics ``` cilium-dbg bpf metrics list [flags] ``` ``` -h, --help help for list -o, --output string json| yaml| jsonpath='{}' ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - BPF datapath traffic metrics
Project: rkt (Runtime / Container Runtime)
File: running-docker-images.md

rkt features native support for fetching and running Docker container images. To reference a Docker image, use the `docker://` prefix when fetching or running images. Note that Docker images do not support signature verification, and hence it's necessary to use the `--insecure-options=image` flag. As a simple example, let's run the latest container image from the default Docker registry: ``` rkt: fetching image from docker://redis rkt: warning: image signature verification has been disabled Downloading layer: 511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158 ... Downloading layer: f2fb89b0a711a7178528c7785d247ba3572924353b0d5e23e9b28f0518253b22 4:C 19 Apr 06:09:02.372 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf 4:M 19 Apr 06:09:02.373 # You requested maxclients of 10000 requiring at least 10032 max file descriptors. 4:M 19 Apr 06:09:02.373 # Redis can't set maximum open files to 10032 because of OS error: Operation not permitted. 4:M 19 Apr 06:09:02.373 # Current maximum open files is 8192. maxclients has been reduced to 8160 to compensate for low ulimit. If you need higher maxclients increase 'ulimit -n'. . .-`` ''-. .-`` `. `. ''-._ Redis 3.0.0 (00000000/0) 64 bit .-`` .-```. ```\/ ., ''-._ ( ' , .-` | `, ) Running in standalone mode |`-.`-...-` ...-.``-.|'` _.-'| Port: 6379 | `-. `. / _.-' | PID: 4 `-. `-. `-./ .-' .-' |`-.`-. `-..-' .-'.-'| | `-.`-. .-'.-' | http://redis.io `-. `-.`-..-'.-' .-' |`-.`-. `-..-' .-'.-'| | `-.`-. .-'.-' | `-. `-.`-..-'.-' .-' `-. `-..-' .-' `-. .-' `-..-' 4:M 19 Apr 06:09:02.374 # Server started, Redis version 3.0.0 4:M 19 Apr 06:09:02.375 # WARNING overcommitmemory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommitmemory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect. 4:M 19 Apr 06:09:02.375 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. 4:M 19 Apr 06:09:02.375 * The server is now ready to accept connections on port 6379 ``` This behaves similarly to the Docker client: if no specific registry is named, the is used by default. As with Docker, alternative registries can be used by specifying the registry as part of the image reference. For example, the following command will fetch an Docker image hosted on : ``` rkt: fetching image from docker://quay.io/zanui/nginx rkt: warning: image signature verification has been disabled Downloading layer: 511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158 ... Downloading layer: 340951f1240f3dc1189ae32cfa5af35df2dc640e0c92f2397b7a72e174c1a158 sha512-c6d6efd98f506380ff128e473ca239ed ``` The hash printed in the final line represents the image ID of the converted ACI. After the image has been retrieved, it can be run by referencing this hash: ``` ```
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-health_get.md

<!-- This file was autogenerated via cilium-agent --cmdref, do not edit manually--> Display local cilium agent status ``` cilium-health get [flags] ``` ``` -h, --help help for get -o, --output string json| yaml| jsonpath='{}' ``` ``` -D, --debug Enable debug messages -H, --host string URI to cilium-health server API --log-driver strings Logging endpoints to use for example syslog --log-opt map Log driver options for cilium-health e.g. syslog.level=info,syslog.facility=local5,syslog.tag=cilium-agent ``` - Cilium Health Client
Project: Soda Foundation (Runtime / Cloud Native Storage)
File: Tutorials-for-Beginners.md

If you are a beginner and expect opensds project as the gate to open source world, this tutorial is one of the best choices for you. Just follow the guidance and you will find the pleasure to becoming a contributor. Before making modifications of opensds project, you need to make sure that this project have been forked to your own repository. It means that there will be parallel development between opensds repo and your own repo, so be careful to avoid the inconsistency between these two repos. If you want to download the code to the local machine, ```git``` is the best way: ``` git clone https://yourrepourl/opensds.git ``` To reduce the conflicts between your remote repo and opensds repo, we SUGGEST you configure opensds as the upstream repo: ``` git remote add upstream https://github.com/sodafoundation/api.git git fetch upstream ``` To avoid inconsistency between multiple branches, we SUGGEST checking out to a new branch: ``` git checkout -b newbranchname upstream/development git pull ``` Then you can change the code arbitrarily. After updating the code, you should push the update in the formal way: ``` git add . git status (Check the update status) git commit -m "Your commit title" git commit --amend (Add the concrete description of your commit) git push origin newbranchname ``` In the last step, your need to pull a compare request between your new branch and opensds development branch. After finishing the pull request, the travis CI will be automatically set up for building test. The tutorial is done, enjoy your contributing work!
Project: CubeFS (Runtime / Cloud Native Storage)
File: user.md

Create user [USER ID]. ``` bash cfs-cli user create [USER ID] [flags] ``` ```bash Flags: --access-key string # Specify the access key for the user to use the object storage function. --secret-key string # Specify the secret key for the user to use the object storage function. --password string # Specify the user password. --user-type string # Specify the user type, optional values are normal or admin (default is normal). -y, --yes # Skip all questions and set the answer to "yes". ``` Delete user [USER ID]. ``` bash cfs-cli user delete [USER ID] [flags] ``` ```bash Flags: -y, --yes # Skip all questions and set the answer to "yes". ``` Get information of user [USER ID]. ```bash cfs-cli user info [USER ID] ``` Get a list of all current users. ```bash cfs-cli user list ``` Update the permission [PERM] of user [USER ID] for volume [VOLUME]. [PERM] can be "READONLY/RO", "READWRITE/RW", or "NONE". ```bash cfs-cli user perm [USER ID] [VOLUME] [PERM] ``` Update the information of user [USER ID]. ```bash cfs-cli user update [USER ID] [flags] ``` ```bash Flags: --access-key string # The updated access key value. --secret-key string # The updated secret key value. --user-type string # The updated user type, optional values are normal or admin. -y, --yes # Skip all questions and set the answer to "yes". ```
Project: Firecracker (Runtime / Container Runtime)
File: pull_request_template.md

... ... By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check . [ ] If a specific issue led to this PR, this PR closes the issue. [ ] The description of changes is clear and encompassing. [ ] Any required documentation changes (code and docs) are included in this PR. . [ ] User-facing changes are mentioned in `CHANGELOG.md`. [ ] All added/changed functionality is tested. [ ] New `TODO`s link to an issue. [ ] Commits meet . .
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_monitor.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Display BPF program events The monitor displays notifications and events emitted by the BPF programs attached to endpoints and devices. This includes: Dropped packet notifications Captured packet traces Policy verdict notifications Debugging information ``` cilium-dbg monitor [flags] ``` ``` --from []uint16 Filter by source endpoint id -h, --help help for monitor --hex Do not dissect, print payload in HEX -j, --json Enable json output. Shadows -v flag --monitor-socket string Configure monitor socket path -n, --numeric Display all security identities as numeric values --related-to []uint16 Filter by either source or destination endpoint id --to []uint16 Filter by destination endpoint id -t, --type []string Filter by event types [agent capture debug drop l7 policy-verdict recorder trace trace-sock] -v, --verbose bools[=false] Enable verbose output (-v, -vv) (default []) ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - CLI
Project: Alluxio (Runtime / Cloud Native Storage)
File: CephObjectStorage.md

layout: global title: CephObjectStorage This guide describes how to configure Alluxio with {:target="_blank"} as the under storage system. Ceph Object Storage is a distributed, open-source storage system designed for storing and retrieving large amounts of unstructured data. It provides a scalable and highly available storage solution that can be deployed on commodity hardware. Alluxio supports two different clients APIs to connect to Ceph Object Storage using {:target="blank"}. For more information, please read its {:target="blank"}. If you haven't already, please see before you get started. In preparation for using Ceph Object Storage with Alluxio: <table class="table table-striped"> <tr> <td markdown="span" style="width:30%">`<CEPH_BUCKET>`</td> <td markdown="span">{:target="_blank"} or use an existing bucket</td> </tr> <tr> <td markdown="span" style="width:30%">`<CEPH_DIRECTORY>`</td> <td markdown="span">The directory you want to use in the bucket, either by creating a new directory or using an existing one</td> </tr> <tr> <td markdown="span" style="width:30%">`<S3ACCESSKEY_ID>`</td> <td markdown="span">Used to sign programmatic requests made to AWS. See {:target="_blank"}</td> </tr> <tr> <td markdown="span" style="width:30%">`<S3SECRETKEY>`</td> <td markdown="span">Used to sign programmatic requests made to AWS. See {:target="_blank"}</td> </tr> <tr> <td markdown="span" style="width:30%">`<RGW_HOSTNAME>`</td> <td markdown="span">The host for the Ceph Object Gateway instance, which can be an IP address or a hostname. Read {:target="_blank"}</td> </tr> <tr> <td markdown="span" style="width:30%">`<RGW_PORT>`</td> <td markdown="span">The port the instance listens for requests and if not specified, Ceph Object Gateway runs external FastCGI. Read {:target="_blank"}</td> </tr> <tr> <td markdown="span" style="width:30%">`<INHERIT_ACL>`</td> <td markdown="span"></td> </tr> </table> To use Ceph Object Storage as the UFS of Alluxio root mount point, you need to configure Alluxio to use under storage systems by modifying `conf/alluxio-site.properties`. If it does not exist, create the configuration file from the template. ```shell $ cp conf/alluxio-site.properties.template conf/alluxio-site.properties ``` Modify `conf/alluxio-site.properties` to include: ```properties alluxio.dora.client.ufs.root=s3://<CEPHBUCKET>/<CEPHDIRECTORY> s3a.accessKeyId=<S3ACCESSKEY_ID> s3a.secretKey=<S3SECRETKEY> alluxio.underfs.s3.endpoint=http://<RGW-HOSTNAME>:<RGW-PORT> alluxio.underfs.s3.disable.dns.buckets=true alluxio.underfs.s3.inherit.acl=<INHERIT_ACL> ``` If using a Ceph release such as hammer (or older) specify `alluxio.underfs.s3.signer.algorithm=S3SignerType` to use v2 S3 signatures. To use GET Bucket (List Objects) Version 1 specify `alluxio.underfs.s3.list.objects.v1=true`. Once you have configured Alluxio to Ceph Object Storage, try to see that everything works. If Alluxio security is enabled, Alluxio enforces the access control inherited from underlying Ceph Object Storage. Depending on the interace used, refer to or
Project: WasmEdge Runtime (Runtime / Container Runtime)
File: OWNER.md

| Maintainer | GitHub ID | Organization | Email | | | | -- | -- | | Michael Yuan | @juntao | Second State | <michael@secondstate.io> | | Hung-Ying Tai(hydai) | @hydai | Second State | <hydai@secondstate.io> | | Yi-Ying He | @q82419 | Second State | <yiying@secondstate.io> | | Shen-Ta Hsieh(BestSteve) | @ibmibmibm | Second State | <beststeve@secondstate.io> | | Committers | GitHub ID | Organization | Email | | | | -- | -- | | dm4 | @dm4 | Second State | <dm4@secondstate.io> | | yi | @0yi0 | Second State | <yi@secondstate.io> | | Sam | @apepkuss | Second State | <sam@secondstate.io> | | danny | @dannypsnl | Second State | <dannypsnl@secondstate.io> | | Shreyas Atre | @SAtacker | SRA VJTI | <shreyasatre16@gmail.com> | | Reviewers | GitHub ID | Organization | Email | | | | -- | -- | | | @gusye1234 | University of Science and Technology of China | <jianbaiye@outlook.com> | | Tricster | @MediosZ | Southeast University | <mediosrity@gmail.com> | | Wenshuo Yang | @sonder-joker | Bytedance | <highmagic@outlook.com> | | csh | @L-jasmine | Second State | <458761603@qq.com> | | Amun | @hangedfish | Giant Network Group Co., Ltd. | <bravohangedman@outlook.com> | | yb | @yanghaku | Nanjing University | <bo.yang@smail.nju.edu.cn> | | WenYuan Huang | @michael1017 | Purdue University | <huan2086@purdue.edu> | | | @am009 | Huazhong University of Science and Technology | <warrenwjk@qq.com> |
Project: Kata Containers (Runtime / Container Runtime)
File: how-to-use-erofs-build-rootfs.md

For kata containers, rootfs is used in the read-only way. EROFS can noticeably decrease metadata overhead. `mkfs.erofs` can generate compressed and uncompressed EROFS images. For uncompressed images, no files are compressed. However, it is optional to inline the data blocks at the end of the file with the metadata. For compressed images, each file will be compressed using the lz4 or lz4hc algorithm, and it will be confirmed whether it can save space. Use No compression of the file if compression does not save space. | | EROFS | EXT4 | XFS | |--|-| | | | Image Size [MB] | 106(uncompressed) | 256 | 126 | On newer `Ubuntu/Debian` systems, it can be installed directly using the `apt` command, and on `Fedora` it can be installed directly using the `dnf` command. ```shell $ apt install erofs-utils $ dnf install erofs-utils ``` If you need to enable the `Lz4` compression feature, `Lz4 1.8.0+` is required, and `Lz4 1.9.3+` is strongly recommended. For some old lz4 versions (lz4-1.8.0~1.8.3), if lz4-static is not installed, the lz4hc algorithm will not be supported. lz4-static can be installed with apt install lz4-static.x86_64. However, these versions have some bugs in compression, and it is not recommended to use these versions directly. If you use `lz4 1.9.0+`, you can directly use the following command to compile. ```shell $ ./autogen.sh $ ./configure $ make ``` The compiled `mkfs.erofs` program will be saved in the `mkfs` directory. Afterwards, the generated tools can be installed to a system directory using make install (requires root privileges). ```shell $ export distro="ubuntu" $ export FS_TYPE="erofs" $ export ROOTFS_DIR="realpath kata-containers/tools/osbuilder/rootfs-builder/rootfs" $ sudo rm -rf "${ROOTFS_DIR}" $ pushd kata-containers/tools/osbuilder/rootfs-builder $ script -fec 'sudo -E SECCOMP=no ./rootfs.sh "${distro}"' $ popd ``` Note: You should only do this step if you are testing with the latest version of the agent. ```shell $ sudo install -o root -g root -m 0550 -t "${ROOTFSDIR}/usr/bin" "${ROOTFSDIR}/../../../../src/agent/target/x86_64-unknown-linux-musl/release/kata-agent" $ sudo install -o root -g root -m 0440 "${ROOTFSDIR}/../../../../src/agent/kata-agent.service" "${ROOTFSDIR}/usr/lib/systemd/system/" $ sudo install -o root -g root -m 0440 "${ROOTFSDIR}/../../../../src/agent/kata-containers.target" "${ROOTFSDIR}/usr/lib/systemd/system/" ``` ```shell $ pushd kata-containers/tools/osbuilder/image-builder $ script -fec 'sudo -E ./imagebuilder.sh "${ROOTFSDIR}"' $ popd ``` ```shell $ pushd kata-containers/tools/osbuilder/image-builder $ commit="$(git log --format=%h -1 HEAD)" $ date="$(date +%Y-%m-%d-%T.%N%z)" $ rootfs="erofs" $ image="kata-containers-${rootfs}-${date}-${commit}" $ sudo install -o root -g root -m 0640 -D kata-containers.img "/usr/share/kata-containers/${image}" $ (cd /usr/share/kata-containers && sudo ln -sf "$image" kata-containers.img) $ popd ``` ```shell $ sudo sed -i -e 's/^# \(rootfs_type\).=.*$/\1 = erofs/g' /etc/kata-containers/configuration.toml ```
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_version.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Print version information ``` cilium-dbg version [flags] ``` ``` -h, --help help for version -o, --output string json| yaml| jsonpath='{}' ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - CLI
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-health_completion_fish.md

<!-- This file was autogenerated via cilium-agent --cmdref, do not edit manually--> Generate the autocompletion script for fish Generate the autocompletion script for the fish shell. To load completions in your current shell session: cilium-health completion fish | source To load completions for every new session, execute once: cilium-health completion fish > ~/.config/fish/completions/cilium-health.fish You will need to start a new shell for this setup to take effect. ``` cilium-health completion fish [flags] ``` ``` -h, --help help for fish --no-descriptions disable completion descriptions ``` ``` -D, --debug Enable debug messages -H, --host string URI to cilium-health server API --log-driver strings Logging endpoints to use for example syslog --log-opt map Log driver options for cilium-health e.g. syslog.level=info,syslog.facility=local5,syslog.tag=cilium-agent ``` - Generate the autocompletion script for the specified shell
Project: rkt (Runtime / Container Runtime)
File: stop.md

Given a list of pod UUIDs, rkt stop will shut them down, for the shipped stage1 images, this means: default systemd-nspawn stage1: the apps in the pod receive a TERM signal and, after a timeout, a KILL signal. kvm stage1: the virtual machine is shut down with `systemctl halt`. rkt fly stage1: the app receives a TERM signal. The `--force` flag will stop a pod forcibly, that is: default systemd-nspawn stage1: the container is killed. kvm stage1: the qemu or lkvm process receives a KILL signal. rkt fly stage1: the app receives a KILL signal. ``` "387fc8eb-eabd-4e77-b080-d8c0001eb50c" "cbbf5c01-dd52-4ccc-a1e0-cfd8f1e88418" "93e516b0-e84b-40cf-a45b-531b14dfcce2" ``` The `--uuid-file` flag may be used to pass a text file with UUID to `stop` command. This can be paired with `--uuid-file-save` flag to stop pods by name: ``` rkt run --uuid-file-save=/run/rkt-uuids/mypod ... rkt stop --uuid-file=/run/rkt-uuids/mypod ``` If you started rkt as a systemd service, you can stop the pod with `systemctl stop`. If you started rkt interactively: For a stage1 with systemd-nspawn, you can stop the pod by pressing `^]` three times within 5 seconds. If you're using systemd on the host, you can also use `machinectl` with the `poweroff` or `terminate` subcommand. For a stage1 with kvm, you can stop the pod by pressing Ctrl+A and then x.