cwielenb/CNCF-Dataset huggingface dataset:
Project: KubeBlocks by ApeCloud (App Definition and Development / Database)
File: kbcli_dataprotection_describe-backup.md

title: kbcli dataprotection describe-backup Describe a backup ``` kbcli dataprotection describe-backup NAME [flags] ``` ``` kbcli dp describe-backup mybackup ``` ``` -h, --help help for describe-backup ``` ``` --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. --as-uid string UID to impersonate for the operation. --cache-dir string Default cache directory (default "$HOME/.kube/cache") --certificate-authority string Path to a cert file for the certificate authority --client-certificate string Path to a client certificate file for TLS --client-key string Path to a client key file for TLS --cluster string The name of the kubeconfig cluster to use --context string The name of the kubeconfig context to use --disable-compression If true, opt-out of response compression for all requests to the server --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kubeconfig string Path to the kubeconfig file to use for CLI requests. --match-server-version Require server version to match client version -n, --namespace string If present, the namespace scope for this CLI request --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -s, --server string The address and port of the Kubernetes API server --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use ``` - Data protection command.
Project: Operator Framework (App Definition and Development / Application Definition & Image Build)
File: documentation.md

title: Documentation linkTitle: Documentation weight: 20 If a contribution changes the user interface or existing APIs it must include new or updated documentation. Since the operator-sdk repository does not expose many public packages, documentation mostly comes in the form of our website's . Good are expected nonetheless. Likewise a should be added containing a summary of the change and optionally a migration guide. This document discusses how to visually inspect documentation changes as they would be applied to the live website. All changes to documentation should be inspected locally before being pushed to a PR. The docs are built with which can be installed along with the required extensions by following the . Note: Be sure to install hugo-extended. We use `git submodules` to install the docsy theme. From the `operator-sdk` directory, update the submodules to install the theme. ```sh git submodule update --init --recursive ``` You can build and serve your docs to `localhost:1313`. From the `website/` directory run: ```sh hugo server ``` Any changes will be included in real time. `make test-docs` will validate changelog fragments, build doc HTML in a container, and check its links. Please consider running this locally before creating a PR to save CI resources.
Project: Vitess (App Definition and Development / Database)
File: DockerBuild.md

We created the `lite` image as a stripped down version of our old image `base` such that Kubernetes pods can start faster. The `lite` image is updated automatically after every push to the GitHub main branch. For more information on the different images we provide, please read the file. If your goal is run the latest Vitess code, the simplest solution is to use the `lite`. Another alternative is to customize our Docker images and build them yourselves. This is described below and involves building the `base` image first. Then you can run our build script for the `lite` image which extracts the Vitess binaries from the built `base` image. Install on your workstation. Our scripts also assume you can run the `docker` command without `sudo`, which you can do by . Create an account on and then `docker login` to it. Go to your `src/vitess.io/vitess` directory. Usually, you won't need to unless you edit or , for example to add new dependencies. If you do need it then build the bootstrap image, otherwise pull the image using one of the following command. ```sh vitess$ docker pull vitess/bootstrap:latest ``` Note: If you have already downloaded the `vitess/bootstrap:<flavor>` image on your machine before then it could be old, which may cause build failures. So it would be a good idea to always execute this step. Build the `vitess/lite[:<flavor>]` image. This will run a script that extracts from `vitess/bootstrap` only the files needed to run Vitess. ```sh vitess$ make docker_lite ``` Re-tag the image under your personal repository, then upload it. ```sh vitess$ docker tag -f vitess/lite yourname/vitess vitess$ docker push yourname/vitess ``` Note: If you chose a non-default flavor above, then change `vitess/lite` in the above command to `vitess/lite:<flavor>`. Launch as usual.
Project: KICS (Provisioning / Security & Compliance)
File: bdecd6db-2600-47dd-a10c-72c97cf17ae9.md

title: EFS Without KMS hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: bdecd6db-2600-47dd-a10c-72c97cf17ae9 Query name: EFS Without KMS Platform: Crossplane Severity: <span style="color:#edd57e">Low</span> Category: Encryption URL: Amazon Elastic Filesystem should have filesystem encryption enabled using KMS CMK customer-managed keys instead of AWS managed-keys<br> ```yaml title="Positive test num. 1 - yaml file" hl_lines="36 6" apiVersion: efs.aws.crossplane.io/v1alpha1 kind: FileSystem metadata: name: example3 spec: forProvider: region: us-east-1 encrypted: false providerConfigRef: name: example apiVersion: apiextensions.crossplane.io/v1 kind: Composition metadata: name: cluster-aws labels: provider: aws cluster: eks spec: compositeTypeRef: apiVersion: mydev.org/v1alpha1 kind: CompositeCluster writeConnectionSecretsToNamespace: crossplane-system patchSets: name: metadata patches: fromFieldPath: metadata.labels resources: name: sample-ec2 base: apiVersion: efs.aws.crossplane.io/v1alpha1 kind: FileSystem metadata: name: example4 spec: forProvider: region: us-east-1 encrypted: false providerConfigRef: name: example ``` ```yaml title="Negative test num. 1 - yaml file" apiVersion: efs.aws.crossplane.io/v1alpha1 kind: FileSystem metadata: name: example spec: forProvider: region: us-east-1 kmsKeyID: 1234abcd-12ab-34cd-56ef-1234567890ab encrypted: true providerConfigRef: name: example apiVersion: apiextensions.crossplane.io/v1 kind: Composition metadata: name: cluster-aws labels: provider: aws cluster: eks spec: compositeTypeRef: apiVersion: mydev.org/v1alpha1 kind: CompositeCluster writeConnectionSecretsToNamespace: crossplane-system patchSets: name: metadata patches: fromFieldPath: metadata.labels resources: name: sample-ec2 base: apiVersion: efs.aws.crossplane.io/v1alpha1 kind: FileSystem metadata: name: example2 spec: forProvider: region: us-east-1 kmsKeyID: 1234abcd-12ab-34cd-56ef-1234567890ab encrypted: true providerConfigRef: name: example ```
Project: Apache Hadoop (App Definition and Development / Database)
File: RELEASENOTES.0.16.4.md

<! --> These release notes cover new developer and user-facing incompatibilities, important issues, features, and major improvements. | Blocker | [HOD] logcondense fails if DFS has files that are not log files, but match a certain pattern* Fixed the regular expression used by the logcondense utility to generate the list of log files to purge from HDFS. Also, improved error handling, so a single invalid log file does not fail the purge process.
Project: Harbor (Provisioning / Container Registry)
File: 5-03-OVA-garbage-collection.md

Test 5-03 - OVA Garbage Collection ======= To verify that an OVA version of Harbor can perform garbage collection to release unused space of deleted images. User guide, installation guide of Harbor OVA version. This test requires an OVA binary of Harbor. A vCenter, at least an ESX host, and a network that supports DHCP. A linux host with Docker CLI installed (Docker client). Deploy an OVA version of Harbor, with "Garbage Collection" set to false. Create a project in Harbor. On a Docker client host, use `docker login <harbor_host>` command to log in as the admin user. Run some `docker push` to push some images to the project. The size of the images should be at least 500MB. In Harbor's UI, delete the newly pushed images. On vSphere, open the console of Harbor's VM, log in as root user, type `df -h /data` command to get the space usage of the /data volume. Take a note of the Used space. Power off the VM. Right click on the VM and select "Edit Settings". Set "Garbage Collection" to true. Power on the VM. Wait for a while until Harbor service is available (check by a browser) On vSphere, open the console of Harbor's VM, log in as root user, type `df -h /data` command to get the space usage of the /data volume and compare with previous number. Check the log file of garbage collection under /data to see if there was any error. Repeat Step 3-7, to create some deleted images. Repeat Step 10-13, to see the garbage collection works on the second reboot. Step 12, the used space should be reduced. The space of deleted images should be recycled. Step 13, log file should contain no errors. Step 15, verify garbage collection works for the second time. None
Project: Podman (App Definition and Development / Application Definition & Image Build)
File: podman-volume-mount.1.md

% podman-volume-mount 1 podman\-volume\-mount - Mount a volume filesystem podman volume mount [volume ...] Mounts the specified volumes' file system in a location which can be accessed from the host, and returns its location. Rootless mode only supports mounting file volumes unless Podman is run within the user namespace via the `podman unshare` command. All other volume types fail to mount. The location of the mounted file system. On error an empty string and errno is returned. Mount specified volume. As Root: ``` /home/dwalsh/.local/share/containers/storage/volumes/foo/_data ``` In rootless mode, volume mounting only works after executing the podman unshare command to enter the user namespace. ``` $ podman unshare /home/dwalsh/.local/share/containers/storage/volumes/foo/_data ``` , , , , mount(8)
Project: DevSpace (App Definition and Development / Application Definition & Image Build)
File: devspace_completion.md

title: "Command - devspace completion" sidebar_label: devspace completion Output shell completion for the given shell (bash or zsh) ``` devspace completion SHELL [flags] ``` ``` Outputs shell completion for the given shell (bash or zsh) This depends on the bash-completion binary. Example installation instructions: OS X: $ brew install bash-completion $ source $(brew --prefix)/etc/bash_completion $ devspace completion bash > ~/.devspace-completion # for bash users $ devspace completion zsh > ~/.devspace-completion # for zsh users $ source ~/.devspace-completion Ubuntu: $ apt-get install bash-completion $ source /etc/bash-completion $ source <(devspace completion bash) # for bash users $ source <(devspace completion zsh) # for zsh users Additionally, you may want to output the completion to a file and source in your .bashrc ``` ``` -h, --help help for completion ``` ``` --config string The devspace config file to use --debug Prints the stack trace if an error occurs --disable-profile-activation If true will ignore all profile activations --inactivity-timeout int Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems (default 180) --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 strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified --profile-parent strings One or more profiles that should be applied before the specified profile (e.g. devspace dev --profile-parent=base1 --profile-parent=base2 --profile=my-profile) --profile-refresh If true will pull and re-download profile parent sources --restore-vars If true will restore the variables from kubernetes before loading the config --save-vars If true will save the variables to kubernetes after loading the config --silent Run in silent mode and prevents any devspace log output except panics & fatals -s, --switch-context DEPRECATED: 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) --vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars") ```
Project: CloudNativePG (App Definition and Development / Database)
File: container_images.md

The CloudNativePG operator for Kubernetes is designed to work with any compatible container image of PostgreSQL that complies with the following requirements: PostgreSQL executables that must be in the path: `initdb` `postgres` `pg_ctl` `pg_controldata` `pg_basebackup` Barman Cloud executables that must be in the path: `barman-cloud-backup` `barman-cloud-backup-delete` `barman-cloud-backup-list` `barman-cloud-check-wal-archive` `barman-cloud-restore` `barman-cloud-wal-archive` `barman-cloud-wal-restore` PGAudit extension installed (optional - only if PGAudit is required in the deployed clusters) Appropriate locale settings !!! Important Only are allowed. No entry point and/or command is required in the image definition, as CloudNativePG overrides it with its instance manager. !!! Warning Application Container Images will be used by CloudNativePG in a Primary with multiple/optional Hot Standby Servers Architecture only. The CloudNativePG community provides and supports that work with CloudNativePG, and publishes them on . To ensure the operator makes informed decisions, it must accurately detect the PostgreSQL major version. This detection can occur in two ways: Utilizing the `major` field of the `imageCatalogRef`, if defined. Auto-detecting the major version from the image tag of the `imageName` if not explicitly specified. For auto-detection to work, the image tag must adhere to a specific format. It should commence with a valid PostgreSQL major version number (e.g., 15.6 or 16), optionally followed by a dot and the patch level. Following this, the tag can include any character combination valid and accepted in a Docker tag, preceded by a dot, an underscore, or a minus sign. Examples of accepted image tags: `12.1` `13.3.2.1-1` `13.4` `14` `15.5-10` `16.0` !!! Warning `latest` is not considered a valid tag for the image. !!! Note Image tag requirements do no apply for images defined in a catalog.
Project: Podman (App Definition and Development / Application Definition & Image Build)
File: podman-volume-import.1.md

% podman-volume-import 1 podman\-volume\-import - Import tarball contents into an existing podman volume podman volume import volume [source] podman volume import imports the contents of a tarball into the podman volume's mount point. The contents of the volume is merged with the content of the tarball with the latter taking precedence. podman volume import can consume piped input when using `-` as source path. The given volume must already exist and is not created by podman volume import. Note: Following command is not supported by podman-remote. Print usage statement Import named volume content from the specified file. ``` $ podman volume import myvol test.tar ``` Import named volume content from stdin. ``` $ gunzip -c hello.tar.gz | podman volume import myvol - ``` Export the content from named volume and pipe it into the named volume via stdin. ``` $ podman volume export oldmyvol | podman volume import myvol - ``` , ,
Project: Presto (App Definition and Development / Database)
File: feature-request.md

name: Feature Request about: Create a feature request labels: 'feature request' assignees: '' <! Provide a general summary of the feature request or improvement in the Title above --> <! Look through existing open and closed feature proposals to see if someone has asked for the feature before --> <! Tell us how it should work --> <! Tell us to which service or component this request is related to --> <! Not obligatory, suggest ideas of how to implement the addition or change --> <! Why do you need this feature or improvement? What is your use case? What are you trying to accomplish? --> <! Providing context helps us come up with a solution that is most useful in the real world -->
Project: Open Policy Agent (OPA) (Provisioning / Security & Compliance)
File: atmos.md

title: Atmos software: aws gcp terraform helm inventors: cloudposse labels: category: Infrastructure as Code type: poweredbyopa tutorials: https://atmos.tools/core-concepts/components/validation/#open-policy-agent-opa code: https://github.com/cloudposse/atmos docs_features: terraform: note: | Atmos can validate Terraform stack before applying them. This is done using the `validate component` command . Workflow automation tool for DevOps. Keep configuration DRY with hierarchical imports of configurations, inheritance, and WAY more.
Project: ShardingSphere (App Definition and Development / Database)
File: encrypt.en.md

+++ title = "Encryption" weight = 5 +++ The YAML configuration approach to data encryption is highly readable, with the YAML format enabling a quick understanding of dependencies between encryption rules. Based on the YAML configuration, ShardingSphere automatically completes the creation of ShardingSphereDataSource objects, reducing unnecessary coding efforts for users. ```yaml rules: !ENCRYPT tables: <table_name> (+): # Encrypt table name columns: <column_name> (+): # Encrypt logic column name cipher: name: # Cipher column name encryptorName: # Cipher encrypt algorithm name assistedQuery (?): name: # Assisted query column name encryptorName: # Assisted query encrypt algorithm name likeQuery (?): name: # Like query column name encryptorName: # Like query encrypt algorithm name encryptors: <encryptalgorithmname> (+): # Encrypt algorithm name type: # Encrypt algorithm type props: # Encrypt algorithm properties ``` Please refer to for more details about type of algorithm. Configure data encryption rules in the YAML file, including data sources, encryption rules, global attributes, and other configuration items. Using the createDataSource of calling the YamlShardingSphereDataSourceFactory object to create ShardingSphereDataSource based on the configuration information in the YAML file. The data encryption YAML configurations are as follows: ```yaml dataSources: unique_ds: dataSourceClassName: com.zaxxer.hikari.HikariDataSource driverClassName: com.mysql.jdbc.Driver jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8 username: root password: rules: !ENCRYPT tables: t_user: columns: username: cipher: name: username encryptorName: aes_encryptor assistedQuery: name: assistedqueryusername encryptorName: assisted_encryptor likeQuery: name: likequeryusername encryptorName: like_encryptor pwd: cipher: name: pwd encryptorName: aes_encryptor assistedQuery: name: assistedquerypwd encryptorName: assisted_encryptor encryptors: aes_encryptor: type: AES props: aes-key-value: 123456abc assisted_encryptor: type: MD5 like_encryptor: type: CHARDIGESTLIKE ``` Read the YAML configuration to create a data source according to the createDataSource method of YamlShardingSphereDataSourceFactory. ```java YamlShardingSphereDataSourceFactory.createDataSource(getFile()); ```
Project: Apache Spark (App Definition and Development / Streaming & Messaging)
File: sql-ref-syntax-ddl-drop-variable.md

layout: global title: DROP TEMPORARY VARIABLE displayTitle: DROP TEMPORARY VARIABLE license: | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The `DROP TEMPORARY VARIABLE` statement drops a temporary variable. An exception will be thrown if the variable does not exist. ```sql DROP TEMPORARY VARIABLE [ IF EXISTS ] variable_name ``` variable_name* Specifies the name of an existing variable. The function name may be optionally qualified with a `system.session` or `session`. Syntax: `[ system. [ session.] ] variable_name` IF EXISTS* If specified, no exception is thrown when the variable does not exist. ```sql -- Create a temporary variable var1 DECLARE VARIABLE var1 INT; -- Drop temporary variable DROP TEMPORARY VARIABLE var1; -- Try to drop temporary variable which is not present DROP TEMPORARY VARIABLE var1; Error: VARIABLENOTFOUND The variable `system`.`session`.`var1` cannot be found. -- Drop temporart variable if it exists DROP TEMPORARY VARIABLE IF EXISTS var1; ```
Project: DevSpace (App Definition and Development / Application Definition & Image Build)
File: devspace_add_provider.md

title: "Command - devspace add provider" sidebar_label: devspace add provider Adds a new cloud provider to the configuration ``` devspace add provider [flags] ``` ``` Add a new cloud provider. Example: devspace add provider app.devspace.cloud ``` ``` -h, --help help for provider --host string The URL DevSpace should use for this provider ``` ``` --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: YugabyteDB (App Definition and Development / Database)
File: abort.diagram.md

<svg class="rrdiagram" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" width="246" height="70" viewbox="0 0 246 70"><path class="connector" d="M0 22h15m60 0h30m106 0h20m-136 25q0 5 5 5h5m57 0h54q5 0 5-5m-131-25q5 0 5 5v33q0 5 5 5h116q5 0 5-5v-33q0-5 5-5m5 0h15"/><polygon points="0,29 5,22 0,15" style="fill:black;stroke-width:0"/><rect class="literal" x="15" y="5" width="60" height="25" rx="7"/><text class="text" x="25" y="22">ABORT</text><rect class="literal" x="105" y="5" width="106" height="25" rx="7"/><text class="text" x="115" y="22">TRANSACTION</text><rect class="literal" x="105" y="35" width="57" height="25" rx="7"/><text class="text" x="115" y="52">WORK</text><polygon points="242,29 246,29 246,15 242,15" style="fill:black;stroke-width:0"/></svg>