cwielenb/CNCF-Dataset huggingface dataset:
Project: Weave Net (Runtime / Cloud Native Network)
File: router-encapsulation.md

title: Weave Net Router Sleeve Encapsulation menu_order: 15 search_type: Documentation When the Weave Net router forwards packets to peers in `sleeve` mode (rather than via the ), the encapsulation looks something like this: +--+ | Name of sending peer | +--+ | Frame 1: Name of capturing peer | +--+ | Frame 1: Name of destination peer | +--+ | Frame 1: Captured payload length | +--+ | Frame 1: Captured payload | +--+ | Frame 2: Name of capturing peer | +--+ | Frame 2: Name of destination peer | +--+ | Frame 2: Captured payload length | +--+ | Frame 2: Captured payload | +--+ | ... | +--+ | Frame N: Name of capturing peer | +--+ | Frame N: Name of destination peer | +--+ | Frame N: Captured payload length | +--+ | Frame N: Captured payload | +--+ The name of the sending peer enables the receiving peer to identify the sender of the UDP packet. This is followed by the meta data and a payload for one or more captured frames. The router will perform batching if it captures several frames very quickly which all need forwarding to the same peer. And in this instance, it will fit as many frames as possible into a single UDP packet. The meta data for each frame contains the names of the capturing and the destination peers. Since the name of the capturing peer is associated with the source MAC of the captured payload, it allows receiving peers to build up their mappings of which client MAC addresses are local to which peers. The destination peer name enables the receiving peer to identify whether this frame is destined for itself or whether it should be forwarded on to some other peer, and accommodate multi-hop routing. This works even when the receiving intermediate peer has no knowledge of the destination MAC: only the original capturing peer needs to determine the destination peer from the MAC. In this way Weave peers never need to exchange the MAC addresses of clients and need not take any special action for ARP traffic and MAC discovery. See Also
Project: Rook (Runtime / Cloud Native Storage)
File: ceph-exporter.md

Use Ceph exporter as the new source of metrics based on performance counters coming from every Ceph daemon. Ceph exporter was created to avoid performance problems at scale obtaining metrics in clusters with high number of daemons (mainly OSDs). The Prometheus manager module was not enough performant to obtain the performance counters from all the daemons along the whole Ceph cluster, so the solution for avoid this problem in big clusters is to have a new daemon collecting all the performance counters from all the daemons in each host, and expose them as standard prometheus metrics at /metrics endpoint for prometheus to scrape each of those endpoints. With the Ceph exporter, the source of metrics changes in the Ceph clusters. There will be two main sources of metrics: Prometheus manager module: It is responsible for exposing all metrics other than ceph daemons performance counters. Ceph exporter: It is responsible for exposing only ceph daemons performance counters as prometheus metrics. Ceph exporter will be deployed in Rook when the `monitoring.metricsDisabled: false` setting is applied in the CephCluster CR and the Ceph version later than 17.2.7. Ceph daemon socket files must have ceph user permission A hostPath is available for ceph daemon socket dirs Ceph-exporter is a daemon for collecting perf counters of ceph daemons from admin socket files and exposing them to /metrics endpoint. So we will need the following things: Deploy it similar to crash collector pod hostPath for ceph daemon socket dirs under `$dataDirHostPath/exporter` Volumes & VolumeMounts for ceph pods & containers for daemon socket files and also ceph config file Add daemonSocketDir to ChownCephDataDirsInitContainer() Provide a /metrics endpoint: It needs a new K8s service. Needs to be scraped by prometheus: We need to use a Prometheus Service Monitor which select the Ceph exporter service The exporter service will be created on each of the node where ceph-exporter pod is running.\ `ceph-exporter-service.yaml` ```yaml apiVersion: v1 kind: Service metadata: name: ceph-exporter-<node> namespace: <namespace> labels: app: rook-ceph-exporter node: <node> spec: internalTrafficPolicy: Cluster ports: name: http-metrics port: 9926 protocol: TCP targetPort: 9926 selector: app: rook-ceph-exporter node: <nodeName> sessionAffinity: None type: ClusterIP ``` A single service monitor that will match all the exporter services. ```yaml apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: name: rook-ceph-exporter namespace: <namespace> spec: namespaceSelector: matchNames: <namespace> selector: matchLabels: app: rook-ceph-exporter endpoints: port: http-metrics path: /metrics interval: 5s ```
Project: HwameiStor (Runtime / Cloud Native Storage)
File: ls.md

sidebar_position: 2 sidebar_label: "Local Storage" Local Storage is one of the modules of HwameiStor which is a cloud-native local storage system. It provisions high performance and persistent LVM volume with local access to applications. Supported volume managers: `LVM`. Supported storage medium: `HDD`, `SSD`, `NVMe`. HwameiStor provisions two kinds of local volumes: LVM and Disk. As a component of HwameiStor, Local Storage provisions two types of local LVM volumes, such as HA and non-HA. For the non-HA local LVM volume, it's the best solution for data persistency in the following use cases: Databases with HA capability, such as MongoDB, etc. Messaging systems with HA capability, such as Kafka, RabbitMQ, etc. Key-value stores with HA capability, such as Redis, etc. Others with HA capability For the HA local LVM volume, it's the best solution for data persistency in the following use cases: Database, such as MySQL, PostgreSQL, etc. Other applications which require the data with HA features. Local Storage is a component of HwameiStor and must work with the module. provides a release plan about local storage and its features.
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_bpf_policy_add.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Add/update policy entry ``` cilium-dbg bpf policy add <endpoint id> <traffic-direction> <identity> [port/proto] [flags] ``` ``` --deny Sets deny mode -h, --help help for add ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - Manage policy related BPF maps
Project: SmartOS (Runtime / Container Runtime)
File: LICENSE.md

The MIT License (MIT) Copyright (c) 2010-2016 Robert Kieffer and other contributors 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: Cilium (Runtime / Cloud Native Network)
File: cilium-agent_completion_bash.md

<!-- This file was autogenerated via cilium-agent --cmdref, do not edit manually--> Generate the autocompletion script for bash Generate the autocompletion script for the bash shell. This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager. To load completions in your current shell session: source <(cilium-agent completion bash) To load completions for every new session, execute once: cilium-agent completion bash > /etc/bash_completion.d/cilium-agent cilium-agent completion bash > $(brew --prefix)/etc/bash_completion.d/cilium-agent You will need to start a new shell for this setup to take effect. ``` cilium-agent completion bash ``` ``` -h, --help help for bash --no-descriptions disable completion descriptions ``` - Generate the autocompletion script for the specified shell
Project: Kube-router (Runtime / Cloud Native Network)
File: USERS.md

Who is using kube-router? ========================= The following is a directory of users who are using kube-router in production. Users (Alphabetically) * Name: DigitalOcean Description: DigitalOcean is using kube-router for production bare-metal Kubernetes clusters globally. Usage: Pod Networking, IPVS Service Proxy, BGP Name: EEN (Eagle Eye Networks, Inc.) Description: Eagle Eye Networks is using kube-router for production bare-metal Kubernetes clusters globally. Usage: Pod Networking, IPVS Service Proxy, Network Policy Controller Contact: @DandyDeveloper Name: enix.io Description: Simplicity, IPVS (including good support of incoming UDP long-living video streams) & BGP export of services IP to upstream BGP routers (allowing easy inbound HA with a pair of top-of-rack arista switches) are some of the killer features for us. Usage: Pod Networking, IPVS Service Proxy, Network Policy Controller Name: Globo.com Description: Globo is using kube-router for production hybrid (bare-metal and VMs) Kubernetes clusters across multiple datacenters on Brazil. Usage: Pod Networking, IPVS Service Proxy, Network Policy Controller, BGP Name: Numberly Description: Numberly is using kube-router for production bare-metal Kubernetes clusters globally. Usage: Pod Networking, BGP, Network Policy Controller Contact: @ramnes @Lujeni Name: PubMatic Description: PubMatic is using kube-router for production kubernetes clusters located in world wide Datacenters. Usage: Pod Networking, BGP If you are using kube-router, please consider adding yourself as a user by opening a pull request to this file and adding a section describing your usage of kube-router or let us know on Slack.
Project: Piraeus Datastore (Runtime / Cloud Native Storage)
File: network-policy.md

[Network Policies] offer a way to restrict network access of specific pods. They can be used to block undesired network connections to specific Pods. Piraeus Datastore provides basic Network Policies that configure restricted access to the LINSTOR Satellites. The provided policy restricts incoming network connections to LINSTOR Satellite to only the following sources: Other LINSTOR Satellite Pods to allow for DRBD replication The LINSTOR Controller Pod, to facilitate LINSTOR Cluster operations Metrics collection from DRBD Reactor. To deploy the Network Policy, apply the following remote resource: ``` $ kubectl apply --server-side -k "https://github.com/piraeusdatastore/piraeus-operator//config/extras/network-policy?ref=v2" networkpolicy.networking.k8s.io/satellite serverside-applied ```
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_fqdn_names.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Show internal state Cilium has for DNS names / regexes ``` cilium-dbg fqdn names [flags] ``` ``` -h, --help help for names ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - Manage fqdn proxy
Project: lxd (Runtime / Container Runtime)
File: projects_create.md

(projects-create)= You can configure projects at creation time or later. However, note that it is not possible to modify the features that are enabled for a project when the project contains instances. To create a project, use the command. For example, to create a project called `my-project`, enter the following command: incus project create my-project You can specify configuration options by using the `--config` flag. See {ref}`ref-projects` for the available configuration options. For example, to create a project called `my-project-shared-images` that isolates instances but allows access to the default project's images, enter the following command: incus project create my-project-shared-images --config features.images=false To create a project called `my-restricted-project` that blocks access to security-sensitive features (for example, container nesting) but allows backups, enter the following command: incus project create my-restricted-project --config restricted=true --config restricted.backups=allow ```{tip} When you create a project without specifying configuration options, {config:option}`project-features:features.profiles` is set to `true`, which means that profiles are isolated in the project. Consequently, the new project does not have access to the `default` profile of the `default` project and therefore misses required configuration for creating instances (like the root disk). To fix this, use the command to add a root disk device to the project's `default` profile. ``` (projects-configure)= To configure a project, you can either set a specific configuration option or edit the full project. Some configuration options can only be set for projects that do not contain any instances. To set a specific configuration option, use the command. For example, to limit the number of containers that can be created in `my-project` to five, enter the following command: incus project set my-project limits.containers=5 To unset a specific configuration option, use the command. ```{note} If you unset a configuration option, it is set to its default value. This default value might differ from the initial value that is set when the project is created. ``` To edit the full project configuration, use the command. For example: incus project edit my-project
Project: CubeFS (Runtime / Cloud Native Storage)
File: datanode.md

Get information of all dataNodes, including ID, address, read/write status, and survival status. ```bash cfs-cli datanode list ``` Show basic information of the dataNode, including status, usage, and the ID of the partition it carries. ```bash cfs-cli datanode info [Address] ``` Decommission the dataNode. The data partitions on this node will be automatically transferred to other available nodes. ```bash cfs-cli datanode decommission [Address] ``` Transfer the data partition on the source dataNode to the target dataNode. ```bash cfs-cli datanode migrate [srcAddress] [dstAddress] ```
Project: Kata Containers (Runtime / Container Runtime)
File: SendMigrationData.md

Name | Type | Description | Notes | - | - | - DestinationUrl | string | | Local | Pointer to bool | | [optional] `func NewSendMigrationData(destinationUrl string, ) *SendMigrationData` NewSendMigrationData instantiates a new SendMigrationData 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 NewSendMigrationDataWithDefaults() *SendMigrationData` NewSendMigrationDataWithDefaults instantiates a new SendMigrationData 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 *SendMigrationData) GetDestinationUrl() string` GetDestinationUrl returns the DestinationUrl field if non-nil, zero value otherwise. `func (o SendMigrationData) 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 *SendMigrationData) SetDestinationUrl(v string)` SetDestinationUrl sets DestinationUrl field to given value. `func (o *SendMigrationData) GetLocal() bool` GetLocal returns the Local field if non-nil, zero value otherwise. `func (o SendMigrationData) GetLocalOk() (bool, bool)` GetLocalOk returns a tuple with the Local field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *SendMigrationData) SetLocal(v bool)` SetLocal sets Local field to given value. `func (o *SendMigrationData) HasLocal() bool` HasLocal returns a boolean if a field has been set.
Project: HwameiStor (Runtime / Cloud Native Storage)
File: disk_expansion.md

sidebar_position: 4 sidebar_label: "Disk Expansion" A storage system is usually expected to expand its capacity by adding a new disk into a storage node. In HwameiStor, it can be done with the following steps. Select a storage node from the HwameiStor system, and add a new disk into it. For example, the storage node and new disk information are as follows: name: k8s-worker-4 devPath: /dev/sdc diskType: SSD After the new disk is added into the storage node `k8s-worker-4`, you can check the disk status as below. Check if the new disk is added into the node successfully ```bash ssh root@k8s-worker-4 lsblk | grep sdc ``` The output may look like: ```none sdc 8:32 0 20G 1 disk ``` Check if the LocalDisk CR already exists for the new disk and the status is "Unclaimed" ```bash kubectl get localdisk | grep k8s-worker-4 | grep sdc ``` The output may look like: ```none k8s-worker-4-sdc k8s-worker-4 Available ``` The new disk should be added into the existing SSD storage pool of the node. If the storage pool doesn't exist, it will be constructed automatically and the new disk should be added into it. ```console $ kubectl apply -f - <<EOF apiVersion: hwameistor.io/v1alpha1 kind: LocalDiskClaim metadata: name: k8s-worker-4-expand spec: nodeName: k8s-worker-4 owner: local-storage description: diskType: SSD EOF ``` Finally, check if the new disk has been added into the node's storage pool successfully by checking the LocalStorageNode CR: ```bash kubectl get localstoragenode k8s-worker-4 ``` The output may look like: ```yaml apiVersion: hwameistor.io/v1alpha1 kind: LocalStorageNode metadata: name: k8s-worker-4 spec: hostname: k8s-worker-4 storageIP: 10.6.182.103 topogoly: region: default zone: default status: pools: LocalStorage_PoolSSD: class: SSD disks: capacityBytes: 214744170496 devPath: /dev/sdb state: InUse type: SSD capacityBytes: 214744170496 devPath: /dev/sdc state: InUse type: SSD freeCapacityBytes: 429488340992 freeVolumeCount: 1000 name: LocalStorage_PoolSSD totalCapacityBytes: 429488340992 totalVolumeCount: 1000 type: REGULAR usedCapacityBytes: 0 usedVolumeCount: 0 volumeCapacityBytesLimit: 429488340992 volumes: state: Ready ```
Project: FabEdge (Runtime / Cloud Native Network)
File: feature_request.md

name: Feature request about: Suggest an idea for this project title: '' labels: '' assignees: '' Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] Describe the solution you'd like A clear and concise description of what you want to happen. Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. Additional context Add any other context or screenshots about the feature request here.
Project: Cilium (Runtime / Cloud Native Network)
File: cilium-dbg_policy_wait.md

<!-- This file was autogenerated via cilium cmdref, do not edit manually--> Wait for all endpoints to have updated to a given policy revision ``` cilium-dbg policy wait <revision> [flags] ``` ``` --fail-wait-time int Wait time after which command fails if endpoint regeration fails (seconds) (default 60) -h, --help help for wait --max-wait-time int Wait time after which command fails (seconds) (default 360) --sleep-time int Sleep interval between checks (seconds) (default 1) ``` ``` --config string Config file (default is $HOME/.cilium.yaml) -D, --debug Enable debug messages -H, --host string URI to server-side API ``` - Manage security policies
Project: SmartOS (Runtime / Container Runtime)
File: sysevent.8.md

sysevent [-j] [class] [subclass1] [subclass2] [...] The `sysevent(8)` tool allows watching for arbitrary sysevents from both the kernel and userland programs. This program will run indefinitely, emitting output on stdout whenever a sysevent is generated. This is a debugging tool; options and output are still evolving and may change in the future. Optionally, a class can be specified as the first operand to limit which sysevents will be watched, as well as subclasses specified as the subsequent operands to further limit the matching events. By default the output is meant to be consumed by humans and is not easily parseable - passing `-j` will cause the program to emit newline separated JSON to stdout instead for easy machine parsing. -c <channel> Bind to the event channel. -h Print help and exit. -j JSON output. -r Print 'ready' event at start. `sysevent` Watch for all sysevents on a system and print human-readable output. `sysevent -j` Same as above, but print newline separated JSON output. `sysevent EC_zfs` Watch for all events related to ZFS. `sysevent ECzfs ESCZFShistoryevent` Watch for only ZFS command events (streaming `zpool history` effectively). `sysevent -c com.sun:zones:status status` Watch for only "status" class events in the zones channel This tool does not work at all in non-global zones. The `time` attribute for each event represents when the event was received by this tool, not necessarily when the event was generated.
Project: Kata Containers (Runtime / Container Runtime)
File: BalloonConfig.md

Name | Type | Description | Notes | - | - | - Size | int64 | | DeflateOnOom | Pointer to bool | Deflate balloon when the guest is under memory pressure. | [optional] [default to false] FreePageReporting | Pointer to bool | Enable guest to report free pages. | [optional] [default to false] `func NewBalloonConfig(size int64, ) *BalloonConfig` NewBalloonConfig instantiates a new BalloonConfig 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 NewBalloonConfigWithDefaults() *BalloonConfig` NewBalloonConfigWithDefaults instantiates a new BalloonConfig 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 *BalloonConfig) GetSize() int64` GetSize returns the Size field if non-nil, zero value otherwise. `func (o BalloonConfig) GetSizeOk() (int64, bool)` GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *BalloonConfig) SetSize(v int64)` SetSize sets Size field to given value. `func (o *BalloonConfig) GetDeflateOnOom() bool` GetDeflateOnOom returns the DeflateOnOom field if non-nil, zero value otherwise. `func (o BalloonConfig) GetDeflateOnOomOk() (bool, bool)` GetDeflateOnOomOk returns a tuple with the DeflateOnOom field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *BalloonConfig) SetDeflateOnOom(v bool)` SetDeflateOnOom sets DeflateOnOom field to given value. `func (o *BalloonConfig) HasDeflateOnOom() bool` HasDeflateOnOom returns a boolean if a field has been set. `func (o *BalloonConfig) GetFreePageReporting() bool` GetFreePageReporting returns the FreePageReporting field if non-nil, zero value otherwise. `func (o BalloonConfig) GetFreePageReportingOk() (bool, bool)` GetFreePageReportingOk returns a tuple with the FreePageReporting field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *BalloonConfig) SetFreePageReporting(v bool)` SetFreePageReporting sets FreePageReporting field to given value. `func (o *BalloonConfig) HasFreePageReporting() bool` HasFreePageReporting returns a boolean if a field has been set.