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

title: kbcli plugin upgrade Upgrade kbcli or kubectl plugins ``` kbcli plugin upgrade [flags] ``` ``` kbcli plugin upgrade myplugin kbcli plugin upgrade --all ``` ``` --all Upgrade all installed plugins -h, --help help for upgrade ``` ``` --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 ``` - Provides utilities for interacting with plugins.
Project: SPIRE (Provisioning / Key Management)
File: plugin_server_upstreamauthority_cert_manager.md

The `cert-manager` plugin uses an instance of running in Kubernetes to to request intermediate signing certificates for SPIRE Server. This plugin will request a signing certificate from cert-manager via a resource. Once the referenced issuer has signed the request, the intermediate and CA bundle is retrieved by SPIRE. This plugin requires access to a Kubernetes cluster running cert-manager and create CertificateRequests. Only issuers that have support for providing signing certificates are supported. The provided kubeconfig must include a Kubernetes client that has in the configured namespace. Care should be taken as to what the identity of the Kubernetes client is, as this may have implications on the [approval flow](https://cert-manager.io/docs/concepts/certificaterequest/#userinfo) if running a custom approver. This plugin requests certificates from the configured issuer. | Configuration | Description | ||--| | kubeconfigfile | (Optional) Path to the kubeconfig used to connect to the Kubernetes cluster. Empty path will attempt to use an in-cluster config. | | namespace | The namespace to create CertificateRequests for signing. | | issuer_name | The name of the issuer to reference in CertificateRequests. | | issuer_kind | (Optional) The kind of the issuer to reference in CertificateRequests. Defaults to "Issuer" if empty. | | issuer_group | (Optional) The group of the issuer to reference in CertificateRequests. Defaults to "cert-manager.io" if empty. | ```hcl UpstreamAuthority "cert-manager" { plugin_data { issuer_name = "spire-ca" issuer_kind = "Issuer" issuer_group = "cert-manager.io" namespace = "sandbox" kubeconfigfile = "/etc/kubernetes/kubeconfig" } } ```
Project: KICS (Provisioning / Security & Compliance)
File: 75ec6890-83af-4bf1-9f16-e83726df0bd0.md

title: Lambda Permission Misconfigured hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 75ec6890-83af-4bf1-9f16-e83726df0bd0 Query name: Lambda Permission Misconfigured Platform: Terraform Severity: <span style="color:#edd57e">Low</span> Category: Best Practices URL: Lambda permission may be misconfigured if the action field is not filled in by 'lambda:InvokeFunction'<br> ```tf title="Positive test num. 1 - tf file" hl_lines="2" resource "awslambdapermission" "positive1" { action = "lambda:DeleteFunction" functionname = awslambdafunction.logging.functionname principal = "logs.eu-west-1.amazonaws.com" sourcearn = "${awscloudwatchloggroup.default.arn}:*" } ``` ```tf title="Negative test num. 1 - tf file" resource "awslambdapermission" "negative1" { action = "lambda:InvokeFunction" functionname = awslambdafunction.logging.functionname principal = "logs.eu-west-1.amazonaws.com" sourcearn = "${awscloudwatchloggroup.default.arn}:*" } ```
Project: ORY Hydra (Provisioning / Key Management)
File: pull_request_template.md

<!-- Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. This text will be included in the changelog. If applicable, include links to documentation or pieces of code. If your change includes breaking changes please add a code block documenting the breaking change: ``` BREAKING CHANGES: This patch changes the behavior of configuration item `foo` to do bar. To keep the existing behavior please do baz. ``` --> <!-- If this pull request is a fix for a known bug, link the issue where the bug was reported in the format of `#1234`; is a fix for a previously unknown bug, explain the bug and how to reproduce it in this pull request; implements a new feature, link the issue containing the design document in the format of `#1234`; improves the documentation, no issue reference is required. Pull requests introducing new features, which do not have a design document linked are more likely to be rejected and take on average 2-8 weeks longer to get merged. You can discuss changes with maintainers either in the Github Discussions in this repository or join the . --> <!-- Put an `x` in the boxes that apply. You can also fill these out after creating the PR. Please be aware that pull requests must have all boxes ticked in order to be merged. If you're unsure about any of them, don't hesitate to ask. We're here to help! --> . [ ] I have referenced an issue containing the design document if my change introduces a new feature. [ ] I am following the . . [ ] I confirm that this pull request does not address a security vulnerability. If this pull request addresses a security vulnerability, I confirm that I got the approval (please contact ) from the maintainers to push the changes. [ ] I have added tests that prove my fix is effective or that my feature works. . <!-- If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... -->
Project: YugabyteDB (App Definition and Development / Database)
File: replication.md

title: Replication metrics headerTitle: Replication linkTitle: Replication metrics headcontent: Monitor xCluster replication description: Learn about YugabyteDB's replication metrics, and how to select and use the metrics. menu: v2.18: identifier: replication parent: metrics-overview weight: 150 type: docs YugabyteDB allows you to asynchronously replicate data between independent YugabyteDB clusters. The replication lag metrics are computed at a tablet level as the difference between Hybrid Logical Clock (HLC) time on the source's tablet server, and the hybrid clock timestamp of the latest record pulled from the source. The following table describes key replication metrics. All metrics are counters and units are microseconds. | Metric (Counter \| microseconds) | Description | | : | :- | | `asyncreplicationcommittedlagmicros` | The time in microseconds for the replication lag on the target cluster. This metric is available only on the source cluster. | | `timesincelast_getchanges` | The time elapsed in microseconds from when the source cluster got a request to replicate from the target cluster. This metric is available only on the source cluster. | | `consumersafetime_lag` | The time elapsed in microseconds between the physical time and safe time. Safe time is when data has been replicated to all the tablets on the consumer cluster. This metric is available only on the target cluster. | | `consumersafetime_skew` | The time elapsed in microseconds for replication between the first and the last tablet replica on the consumer cluster. This metric is available only on the target cluster. |
Project: YugabyteDB (App Definition and Development / Database)
File: yba_storage-config_gcs_delete.md

Delete a GCS YugabyteDB Anywhere storage configuration Delete a GCS storage configuration in YugabyteDB Anywhere ``` yba storage-config gcs delete [flags] ``` ``` -f, --force [Optional] Bypass the prompt for non-interactive usage. -h, --help help for delete ``` ``` -a, --apiToken string YugabyteDB Anywhere api token. --config string Config file, defaults to $HOME/.yba-cli.yaml --debug Use debug mode, same as --logLevel debug. --disable-color Disable colors in output. (default false) -H, --host string YugabyteDB Anywhere Host (default "http://localhost:9000") -l, --logLevel string Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info") -n, --name string [Optional] The name of the storage configuration for the operation. Required for create, delete, describe, update. -o, --output string Select the desired output format. Allowed values: table, json, pretty. (default "table") --timeout duration Wait command timeout, example: 5m, 1h. (default 168h0m0s) --wait Wait until the task is completed, otherwise it will exit immediately. (default true) ``` - Manage a YugabyteDB Anywhere GCS storage configuration
Project: YugabyteDB (App Definition and Development / Database)
File: extension-spi.md

title: spi extension headerTitle: spi extension linkTitle: spi description: Using the spi extension in YugabyteDB menu: v2.18: identifier: extension-spi parent: pg-extensions weight: 20 type: docs The module provides several workable examples of using the Server Programming Interface (SPI) and triggers. YugabyteDB supports the following four (of five &mdash; `timetravel` is not currently supported) extensions provided in the spi module: `autoinc` functions auto-increment fields. `insert_username` functions track who changed a table. `moddatetime` functions track last modification times. `refint` functions implement referential integrity. Connect using `ysqlsh` and run the following commands: ```sql CREATE EXTENSION insert_username; CREATE EXTENSION moddatetime; ``` Set up a table with triggers for tracking modification time and user (role): ```sql CREATE TABLE spi_test ( id int primary key, content text, username text not null, moddate timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL ); CREATE TRIGGER insert_usernames BEFORE INSERT OR UPDATE ON spi_test FOR EACH ROW EXECUTE PROCEDURE insert_username (username); CREATE TRIGGER update_moddatetime BEFORE UPDATE ON spi_test FOR EACH ROW EXECUTE PROCEDURE moddatetime (moddate); ``` Insert some rows. Each insert should add the current role as `username` and the current timestamp as `moddate`. ```sql SET ROLE yugabyte; INSERT INTO spi_test VALUES(1, 'desc1'); SET ROLE postgres; INSERT INTO spi_test VALUES(2, 'desc2'); INSERT INTO spi_test VALUES(3, 'desc3'); SET ROLE yugabyte; INSERT INTO spi_test VALUES(4, 'desc4'); SELECT * FROM spi_test ORDER BY id; ``` ```output id | content | username | moddate -++-+- 1 | desc1 | yugabyte | 2019-09-13 16:55:53.969907 2 | desc2 | postgres | 2019-09-13 16:55:53.983306 3 | desc3 | postgres | 2019-09-13 16:55:53.98658 4 | desc4 | yugabyte | 2019-09-13 16:55:53.991315 (4 rows) ``` The `yugabyte` and (for compatibility) `postgres` YSQL users are created by default. Update some rows. This should update both `username` and `moddate` accordingly. ```sql UPDATE spitest SET content = 'desc1updated' WHERE id = 1; UPDATE spitest SET content = 'desc3updated' WHERE id = 3; SELECT * FROM spi_test ORDER BY id; ``` ```output id | content | username | moddate -++-+- 1 | desc1_updated | yugabyte | 2019-09-13 16:56:27.623513 2 | desc2 | postgres | 2019-09-13 16:55:53.983306 3 | desc3_updated | yugabyte | 2019-09-13 16:56:27.634099 4 | desc4 | yugabyte | 2019-09-13 16:55:53.991315 (4 rows) ```
Project: Lagoon (App Definition and Development / Application Definition & Image Build)
File: install-harbor.md

Add Helm repository: ```bash title="Add Helm repository" helm repo add harbor https://helm.goharbor.io ``` Consider the optimal configuration of Harbor for your particular circumstances - see for more recommendations: We recommend using S3-compatible storage for image blobs (`imageChartStorage`). We recommend using a managed database service for the Postgres service (`database.type`). In high-usage scenarios we recommend using a managed Redis service. (`redis.type`) Create the file `harbor-values.yml` inside of your config directory. The proxy-buffering annotations help with large image pushes: ```yaml title="harbor-values.yml" expose: ingress: annotations: kubernetes.io/tls-acme: "true" nginx.ingress.kubernetes.io/proxy-buffering: "off" nginx.ingress.kubernetes.io/proxy-request-buffering: "off" hosts: core: harbor.lagoon.example.com tls: enabled: true certSource: secret secret: secretName: harbor-harbor-ingress externalURL: https://harbor.lagoon.example.com harborAdminPassword: <your Harbor Admin Password> chartmuseum: enabled: false clair: enabled: false notary: enabled: false trivy: enabled: false jobservice: jobLogger: stdout ``` Install Harbor, checking the for the currently supported Harbor versions: ```bash title="Install Harbor" helm upgrade --install --create-namespace \ --namespace harbor --wait \ -f harbor-values.yml \ harbor harbor/harbor ``` Visit Harbor at the URL you set in `harbor.yml`. Username: admin Password: ```bash title="Get Harbor secret" kubectl -n harbor get secret harbor-core -o jsonpath="{.data.HARBORADMINPASSWORD}" | base64 --decode ``` You will need to add the above Harbor credentials to the Lagoon Remote `values.yml` in the next step, as well as `harbor-values.yml`.
Project: ko (App Definition and Development / Application Definition & Image Build)
File: ko.md

Rapidly iterate with Go, Containers, and Kubernetes. ``` ko [flags] ``` ``` -h, --help help for ko -v, --verbose Enable debug logs ``` - Apply the input files with image references resolved to built/pushed image digests. - Build and publish container images from the given importpaths. - Create the input files with image references resolved to built/pushed image digests. - See "kubectl help delete" for detailed usage. - Log in to a registry - Print the input files with image references resolved to built/pushed image digests. - A variant of `kubectl run` that containerizes IMPORTPATH first. - Print ko version.
Project: Meshery (Provisioning / Automation & Configuration)
File: mesheryctl-system-context-switch.md

layout: default title: mesheryctl-system-context-switch permalink: reference/mesheryctl/system/context/switch redirect_from: reference/mesheryctl/system/context/switch/ type: reference display-title: "false" language: en command: system subcommand: context switch context Configure mesheryctl to actively use one one context vs. another context <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl system context switch context-name [flags] </div> </pre> Switch to context named "sample" <pre class='codeblock-pre'> <div class='codeblock'> mesheryctl system context switch sample </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> -h, --help help for switch </div> </pre> <pre class='codeblock-pre'> <div class='codeblock'> --config string path to config file (default "/home/runner/.meshery/config.yaml") -c, --context string (optional) temporarily change the current context. -v, --verbose verbose output -y, --yes (optional) assume yes for user interactive prompts. </div> </pre> Usage of mesheryctl context switch Go back to , if you want to add content manually to the CLI documentation, please refer to the for guidance.
Project: ORY Hydra (Provisioning / Key Management)
File: IsReady503Response.md

Name | Type | Description | Notes | - | - | - Errors | Pointer to map[string]string | Errors contains a list of errors that caused the not ready status. | [optional] `func NewIsReady503Response() *IsReady503Response` NewIsReady503Response instantiates a new IsReady503Response 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 NewIsReady503ResponseWithDefaults() *IsReady503Response` NewIsReady503ResponseWithDefaults instantiates a new IsReady503Response 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 *IsReady503Response) GetErrors() map[string]string` GetErrors returns the Errors field if non-nil, zero value otherwise. `func (o IsReady503Response) GetErrorsOk() (map[string]string, bool)` GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. `func (o *IsReady503Response) SetErrors(v map[string]string)` SetErrors sets Errors field to given value. `func (o *IsReady503Response) HasErrors() bool` HasErrors returns a boolean if a field has been set.
Project: Chef InSpec (Provisioning / Security & Compliance)
File: google_appengine_standard_app_versions.md

+++ title = "googleappenginestandardappversions resource" draft = false gh_repo = "inspec" platform = "gcp" [menu] [menu.inspec] title = "googleappenginestandardappversions" identifier = "inspec/resources/gcp/googleappenginestandardappversions.md googleappenginestandardappversions resource" parent = "inspec/resources/gcp" +++ A `googleappenginestandardappversions` is used to test a Google StandardAppVersion resource ```ruby describe googleappenginestandardappversions(project: 'chef-gcp-inspec', location: 'europe-west2',service: 'default') do its('runtimes') { should include 'nodejs10' } end ``` Properties that can be accessed from the `googleappenginestandardappversions` resource: See the resource for more information. `names` : an array of `googleappenginestandardappversion` name `version_ids` : an array of `googleappenginestandardappversion` version_id `runtimes` : an array of `googleappenginestandardappversion` runtime `threadsaves` : an array of `googleappenginestandardappversion` threadsafe `instance_classes` : an array of `googleappenginestandardappversion` instance_class `automatic_scalings` : an array of `googleappenginestandardappversion` automatic_scaling `basic_scalings` : an array of `googleappenginestandardappversion` basic_scaling `manual_scalings` : an array of `googleappenginestandardappversion` manual_scaling This resource supports all of the above properties as filter criteria, which can be used with `where` as a block or a method. Ensure the is enabled for the current project.
Project: Harbor (Provisioning / Container Registry)
File: 9-01-DB-user-push-signed-images.md

Test 9-01 User push signed images(DB mode) ======= To verify user can push images with content trust enabled. User guide This test requires one Harbor instance is running and available. A Linux host with Docker CLI installed (Docker client). NOTE: In below test, <harborip> should be replaced by your harbor's ip or FQDN. If you are using a self-signed certificate,make sure to copy the CA root cert into ```/etc/docker/certs.d/<harborip>``` and ```$HOME/.docker/tls/<harbor_ip>:4443/``` Login UI and create a project. On Docker client, run ```sh export DOCKERCONTENTTRUST=1 export DOCKERCONTENTTRUSTSERVER=https://<harborip>:4443 ``` and login Harbor. Push an image to the project created in step1. In step3, Docker client will sign and push the image, a green tick will show in UI. None
Project: Trivy (Provisioning / Security & Compliance)
File: acr.md

None, Trivy uses Azure SDK for Go. You don't need to install `az` command. Service principal must have the `AcrPull` permissions. ```bash export SPDATA=$(az ad sp create-for-rbac --name TrivyTest --role AcrPull --scope "/subscriptions/<subscriptionid>/resourceGroups/<resourcegroup>/providers/Microsoft.ContainerRegistry/registries/<registryname>") ``` ```bash export AZURECLIENTID=$(echo $SP_DATA | jq -r '.appId') export AZURECLIENTSECRET=$(echo $SP_DATA | jq -r '.password') export AZURETENANTID=$(echo $SP_DATA | jq -r '.tenant') ``` You can test credentials in the following manner. ```bash docker run -it --rm -v /tmp:/tmp \ -e AZURECLIENTID -e AZURECLIENTSECRET -e AZURETENANTID \ aquasec/trivy image yourspecialproject.azurecr.io/yourspecialimage:yourspecialtag ```
Project: Apache Spark (App Definition and Development / Streaming & Messaging)
File: WINDOWS.md

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. To build SparkR on Windows, the following steps are required Make sure `bash` is available and in `PATH` if you already have a built-in `bash` on Windows. If you do not have, install . Install R (>= 3.5) and . Make sure to include Rtools and R in `PATH`. Install JDK that SparkR supports (see `R/pkg/DESCRIPTION`), and set `JAVA_HOME` in the system environment variables. Download and install . Also include the `bin` directory in Maven in `PATH`. Set `MAVEN_OPTS` as described in . Open a command shell (`cmd`) in the Spark directory and build Spark with and include the `-Psparkr` profile to build the R package. For example to use the default Hadoop versions you can run ```bash mvn.cmd -DskipTests -Psparkr package ``` Note that `.\build\mvn` is a shell script so `mvn.cmd` on the system should be used directly on Windows. Make sure your Maven version is matched to `maven.version` in `./pom.xml`. Note that it is a workaround for SparkR developers on Windows. Apache Spark does not officially support to build on Windows yet whereas it supports to run on Windows. To run the SparkR unit tests on Windows, the following steps are required assuming you are in the Spark root directory and do not have Apache Hadoop installed already: Create a folder to download Hadoop related files for Windows. For example, `cd ..` and `mkdir hadoop`. Download the relevant Hadoop bin package from . While these are not official ASF artifacts, they are built from the ASF release git hashes by a Hadoop PMC member on a dedicated Windows VM. For further reading, consult . Install the files into `hadoop\bin`; make sure that `winutils.exe` and `hadoop.dll` are present. Set the environment variable `HADOOP_HOME` to the full path to the newly created `hadoop` directory. Run unit tests for SparkR by running the command below. You need to install the needed packages following the instructions under first: ``` .\bin\spark-submit2.cmd --conf spark.hadoop.fs.defaultFS="file:///" R\pkg\tests\run-all.R ```