cwielenb/CNCF-Dataset huggingface dataset:
Project: Apache Mesos (Orchestration & Management / Scheduling & Orchestration)
File: reopening-reviews.md

title: Apache Mesos - Reopening Reviews layout: documentation Sometimes, a review you've submitted may fall through the cracks. In general, we will close reviews on that show no activity for several months. Before you reopen the review, consider taking the following steps to avoid a repeat scenario: Make sure there is a associated with your review. The JIRA should be "accepted" by another member of the community and you should be assigned to the issue. Check in with the and see if there is interest. For bug fixes or documentation updates, you should . For improvements or new features, you should to collaborate on your design and review. Update your review. Chances are, the codebase has changed significantly since you last uploaded the review. Also make sure your review's summary is sensible and the description explains the problem and proposed solution.
Project: Contour (Orchestration & Management / Service Proxy)
File: CHANGELOG-v1.25.1.md

We are delighted to present version v1.25.1 of Contour, our layer 7 HTTP reverse proxy for Kubernetes clusters. Update to Envoy v1.26.4. See the for more information about the content of the release. Update to Go v1.20.6. See the for more information. Failure to automatically set GOMAXPROCS using the library is no longer fatal. Contour will now simply log the error and continue with the automatic GOMAXPROCS detection ignored. For a fresh install of Contour, consult the . To upgrade an existing Contour installation, please consult the . Contour v1.25.1 is tested against Kubernetes 1.25 through 1.27. If you're using Contour and want to add your organization to our adopters list, please visit this . If you prefer to keep your organization name anonymous but still give us feedback into your usage and scenarios for Contour, please post on this .
Project: Apache bRPC (Orchestration & Management / Remote Procedure Call)
File: bazel_support.md

bRPC relies on a number of open source libraries that do not provide bazel support, so you will need to manually add some of these dependencies to your build project. Move the BUILD file /example/buildwithbazel/*.BUILD and brpc_workspace.bzl to the root of your project, and add the contents of ```c++ load("@//:brpcworkspace.bzl", "brpcworkspace") brpc_workspace(); ``` to your WORKSPACE link apache_brpc like: ```c++ ... deps = [ "@apache_brpc//:bthread", "@apache_brpc//:brpc", "@apache_brpc//:butil", "@apache_brpc//:bvar", ] ... ```
Project: Gloo (Orchestration & Management / API Gateway)
File: glooctl_istio_disable-mtls.md

title: "glooctl istio disable-mtls" weight: 5 Disables Istio mTLS for a given upstream Disables Istio mTLS for a given upstream, by removing the sslConfig which lets envoy know to get the certs via SDS ``` glooctl istio disable-mtls [flags] ``` ``` -h, --help help for disable-mtls -u, --upstream string upstream for which the istio sslConfig needs to change ``` ``` -c, --config string set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml") --consul-address string address of the Consul server. Use with --use-consul (default "127.0.0.1:8500") --consul-allow-stale-reads Allows reading using Consul's stale consistency mode. --consul-datacenter string Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul --consul-root-key string key prefix for for Consul key-value storage. (default "gloo") --consul-scheme string URI scheme for the Consul server. Use with --use-consul (default "http") --consul-token string Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul -i, --interactive use interactive mode --kube-context string kube context to use when interacting with kubernetes --kubeconfig string kubeconfig to use, if not standard one --name string name of the resource to read or write -n, --namespace string namespace for reading or writing resources (default "gloo-system") --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) ``` - Commands for interacting with Istio in Gloo
Project: Gravitee.io (Orchestration & Management / API Gateway)
File: management-api.md

Set general information about your API such as its name, version, picture and description. You can switch API visibility to restrict access to the API. Portal section let you add some labels and categories to categorize your API and make it easier to find for the consumers. IMPORT button will load and replace API data from the imported API definition. EXPORT button will export your API as API definition json format to easily recreate your API for a different environment for example.
Project: Traefik (Orchestration & Management / API Gateway)
File: spiffe.md

title: "Traefik SPIFFE Documentation" description: "Learn how to configure Traefik to use SPIFFE. Read the technical documentation." Secure the backend connection with SPIFFE. {: .subtitle } (Secure Production Identity Framework For Everyone), provides a secure identity in the form of a specially crafted X.509 certificate, to every workload in an environment. Traefik is able to connect to the Workload API to obtain an x509-SVID used to secure the connection with SPIFFE enabled backends. Enabling SPIFFE is part of the . It can be defined by using a file (YAML or TOML) or CLI arguments. The `workloadAPIAddr` configuration defines the address of the SPIFFE . !!! info "Enabling SPIFFE in ServersTransports" Enabling SPIFFE does not imply that backend connections are going to use it automatically. Each or , that is meant to be secured with SPIFFE, must explicitly enable it (see or ). !!! warning "SPIFFE can cause Traefik to stall" When using SPIFFE, Traefik will wait for the first SVID to be delivered before starting. If Traefik is hanging when waiting on SPIFFE SVID delivery, please double check that it is correctly registered as workload in your SPIFFE infrastructure. ```yaml tab="File (YAML)" spiffe: workloadAPIAddr: localhost ``` ```toml tab="File (TOML)" [spiffe] workloadAPIAddr: localhost ``` ```bash tab="CLI" --spiffe.workloadAPIAddr=localhost ```
Project: MetalLB (Orchestration & Management / Service Proxy)
File: code-of-conduct.md

title: Code of Conduct weight: 1 In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. Examples of behavior that contributes to creating a positive environment include: Using welcoming and inclusive language Being respectful of differing viewpoints and experiences Gracefully accepting constructive criticism Focusing on what is best for the community Showing empathy towards other community members Examples of unacceptable behavior by participants include: The use of sexualized language or imagery and unwelcome sexual attention or advances Trolling, insulting/derogatory comments, and personal or political attacks Public or private harassment Publishing others' private information, such as a physical or electronic address, without explicit permission Other conduct which could reasonably be considered inappropriate in a professional setting Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting fpaoline@redhat.com and rbryant@redhat.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. This Code of Conduct is adapted from the , version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
Project: Kubernetes (Orchestration & Management / Scheduling & Orchestration)
File: md_docs.md

Generating Markdown pages from a cobra command is incredibly easy. An example is as follows: ```go package main import ( "log" "github.com/spf13/cobra" "github.com/spf13/cobra/doc" ) func main() { cmd := &cobra.Command{ Use: "test", Short: "my test program", } err := doc.GenMarkdownTree(cmd, "/tmp") if err != nil { log.Fatal(err) } } ``` That will get you a Markdown document `/tmp/test.md` This program can actually generate docs for the kubectl command in the kubernetes project ```go package main import ( "log" "io/ioutil" "os" "k8s.io/kubernetes/pkg/kubectl/cmd" cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util" "github.com/spf13/cobra/doc" ) func main() { kubectl := cmd.NewKubectlCommand(cmdutil.NewFactory(nil), os.Stdin, ioutil.Discard, ioutil.Discard) err := doc.GenMarkdownTree(kubectl, "./") if err != nil { log.Fatal(err) } } ``` This will generate a whole series of files, one for each command in the tree, in the directory specified (in this case "./") You may wish to have more control over the output, or only generate for a single command, instead of the entire command tree. If this is the case you may prefer to `GenMarkdown` instead of `GenMarkdownTree` ```go out := new(bytes.Buffer) err := doc.GenMarkdown(cmd, out) if err != nil { log.Fatal(err) } ``` This will write the markdown doc for ONLY "cmd" into the out, buffer. Both `GenMarkdown` and `GenMarkdownTree` have alternate versions with callbacks to get some control of the output: ```go func GenMarkdownTreeCustom(cmd *Command, dir string, filePrepender, linkHandler func(string) string) error { //... } ``` ```go func GenMarkdownCustom(cmd Command, out bytes.Buffer, linkHandler func(string) string) error { //... } ``` The `filePrepender` will prepend the return value given the full filepath to the rendered Markdown file. A common use case is to add front matter to use the generated documentation with : ```go const fmTemplate = ` date: %s title: "%s" slug: %s url: %s ` filePrepender := func(filename string) string { now := time.Now().Format(time.RFC3339) name := filepath.Base(filename) base := strings.TrimSuffix(name, path.Ext(name)) url := "/commands/" + strings.ToLower(base) + "/" return fmt.Sprintf(fmTemplate, now, strings.Replace(base, "_", " ", -1), base, url) } ``` The `linkHandler` can be used to customize the rendered internal links to the commands, given a filename: ```go linkHandler := func(name string) string { base := strings.TrimSuffix(name, path.Ext(name)) return "/commands/" + strings.ToLower(base) + "/" } ```
Project: Gloo (Orchestration & Management / API Gateway)
File: glooctl_get.md

title: "glooctl get" weight: 5 Display one or a list of Gloo resources ``` glooctl get [flags] ``` ``` -h, --help help for get --name string name of the resource to read or write -n, --namespace string namespace for reading or writing resources (default "gloo-system") -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) ``` ``` -c, --config string set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml") --consul-address string address of the Consul server. Use with --use-consul (default "127.0.0.1:8500") --consul-allow-stale-reads Allows reading using Consul's stale consistency mode. --consul-datacenter string Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul --consul-root-key string key prefix for for Consul key-value storage. (default "gloo") --consul-scheme string URI scheme for the Consul server. Use with --use-consul (default "http") --consul-token string Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul -i, --interactive use interactive mode --kube-context string kube context to use when interacting with kubernetes --kubeconfig string kubeconfig to use, if not standard one --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) ``` - CLI for Gloo - read an authconfig or list authconfigs in a namespace - read a proxy or list proxies in a namespace - read a ratelimitconfig or list ratelimitconfigs in a namespace - read a route table or list route tables in a namespace - read an upstream or list upstreams in a namespace - read an upstream group or list upstream groups in a namespace - read a virtualservice or list virtualservices in a namespace
Project: Nomad (Orchestration & Management / Scheduling & Orchestration)
File: DEVELOPMENT_MODE.md

:warning: Running the Web UI in development mode is only necessary when debugging issues. Unless you are debugging an issue, please only use the Web UI contained in the Nomad binary. :warning: The production Web UI concatenates and minifies JavaScript and CSS. This can make errors cryptic or useless. In development mode, files are as expected and stack traces are useful. Debugging Web UI issues with the Web UI in development mode is done in three steps: Cloning the Nomad Repo Setting up your environment (or using Vagrant) Serving the Web UI locally while proxying to the production Nomad cluster The Web UI is part of the same repo as Nomad itself. Clone the repo . The includes a list of software prerequisites and instructions for running the UI locally or with the Vagrant VM. Serving the Web UI is done with a single command in the `/ui` directory. Local: `ember serve` Vagrant: `ember serve --watch polling --port 4201` However, this will use the as a backend. To use your own Nomad cluster as a backend, use the proxy option. Local: `ember serve --proxy https://demo.example.com` Vagrant: `ember serve --watch polling --port 4201 --proxy https://demo.example.com` The Web UI will now be accessible from your host machine. Local: Vagrant:
Project: Docker Swarm (Orchestration & Management / Scheduling & Orchestration)
File: PULL_REQUEST_TEMPLATE.md

<! Describe your changes in detail here. If this fixes an issue, please write "Fixes #123", substituting the issue number. --> <! Go over all the following points, and put an `x` in all the boxes that apply. Feel free to not tick any boxes that don't apply to this PR (e.g. refactoring may not need a CHANGELOG update). If you're unsure about any of these, don't hesitate to ask. We're here to help! --> . Adjust the draft version number according to rules. accordingly.
Project: Gloo (Orchestration & Management / API Gateway)
File: glooctl_get_authconfig.md

title: "glooctl get authconfig" weight: 5 read an authconfig or list authconfigs in a namespace usage: glooctl get authconfig [NAME] [--namespace=namespace] [-o FORMAT] ``` glooctl get authconfig [flags] ``` ``` -h, --help help for authconfig ``` ``` -c, --config string set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml") --consul-address string address of the Consul server. Use with --use-consul (default "127.0.0.1:8500") --consul-allow-stale-reads Allows reading using Consul's stale consistency mode. --consul-datacenter string Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul --consul-root-key string key prefix for for Consul key-value storage. (default "gloo") --consul-scheme string URI scheme for the Consul server. Use with --use-consul (default "http") --consul-token string Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul -i, --interactive use interactive mode --kube-context string kube context to use when interacting with kubernetes --kubeconfig string kubeconfig to use, if not standard one --name string name of the resource to read or write -n, --namespace string namespace for reading or writing resources (default "gloo-system") -o, --output OutputType output format: (yaml, json, table, kube-yaml, wide) (default table) --use-consul use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies) ``` - Display one or a list of Gloo resources
Project: Gloo (Orchestration & Management / API Gateway)
File: websockets.md

title: Websockets weight: 40 description: Learn how to configure Websockets support in Gloo Edge Websockets is a protocol allowing full-duplex communication through a single TCP connection. Gloo Edge enables websocket upgrades by default without any additional configuration changes. This document will show how to fine tune the websocket support as needed. Since websocket upgrades are enabled by default on an entire , we can use the configuration on the to turn off websocket upgrades for all connections on that listener. For example, the default `gateway-proxy` can be configured like the following: {{< highlight yaml "hl_lines=14-16" >}} apiVersion: gateway.solo.io/v1 kind: Gateway metadata: labels: app: gloo name: gateway-proxy namespace: gloo-system spec: bindAddress: '::' bindPort: 8080 httpGateway: options: httpConnectionManagerSettings: upgrades: websocket: enabled: false proxyNames: gateway-proxy useProxyProto: false {{< /highlight >}} Note the `httpGateway` configuration above with settings for the `httpConnectionManager`. We can also configure whether websocket is enabled per route as we see in the next section. If you need more fine-grained control configuring websockets, you can use the {{< protobuf name="gateway.solo.io.Route" display="Route">}} configuration in a {{< protobuf name="gateway.solo.io.VirtualService" display="VirtualService">}}. For example, if you have websockets disabled for your listener (as seen in previous section), you can enable it per route with the following: {{< highlight yaml "hl_lines=8-10" >}} matchers: prefix: /foo routeAction: single: upstream: name: foo namespace: gloo-system options: upgrades: websocket: {} {{< /highlight >}} Please reach out to us on or if you're having trouble configuring websockets. For background on Traffic Management, check out the dealing with the topic. You may also be interested in how are made and the possible .
Project: Avro (Orchestration & Management / Remote Procedure Call)
File: avro-1.6.0-released.md

title: "Avro 1.6.0" linkTitle: "Avro 1.6.0" date: 2011-11-02 <!-- 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 https://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. --> Apache Avro 1.6.0 has been released!
Project: Apache Thrift (Orchestration & Management / Remote Procedure Call)
File: RELEASING.md

Publishing the Rust thrift crate is straightforward, and involves two major steps: Setting up your account (one-time) Packaging/publishing the Rust thrift crate itself Go to and click the `Log In` button at the top right. Log in as the Github user with write permissions to the thrift repo! Click your user icon button at the top right and select `Account Settings`. Click `New Token` next to `API Access`. This generates a new API key that cargo uses to publish packages to crates.io. Store this API key somewhere safe. If you will only use this Github account to publish crates to crates.io you can follow the instructions to save the generated key to `~/.cargo/credentials`. You can use the automated script or run the release steps manually. Important: `cargo` expects that version numbers follow the semantic versioning format. This means that `THRIFTRELEASEVERSION` must have a major, minor and patch number, i.e., must be in the form `#.##.##`. Run `./release.sh [THRIFTRELEASEVERSION]`. Requires you to have stored your credentials in `~/.cargo/credentials`. Edit `Cargo.toml` and update the `version = 1.0` key to `version = [THRIFTRELEASEVERSION]` `git add Cargo.toml` `git commit -m "Update thrift crate version to [THRIFTRELEASEVERSION]" -m "Client: rs"` `cargo login` (not required if you have stored your credentials in `~/.cargo/credentials`) `cargo clean` `cargo package` This step fails if there are any uncommitted or ignored files. Do not use the `--allow-dirty` flag! Instead, add the highlighted files as entries in the `Cargo.toml` `exclude` key. `cargo publish`
Project: k8gb (Orchestration & Management / Coordination & Service Discovery)
File: deploy_ns1.md

Here we provide an example of k8gb deployment in AWS context with NS1 as edgeDNS provider Two EKS clusters in `eu-west-1` and `us-east-1`. The EKS setup is identical to Terraform code for cluster reference setup can be found Use `helm` to deploy stable release from Helm repo ```sh helm repo add k8gb https://www.k8gb.io ``` Example `values.yaml` configuration files can be found In `eu-west-1` cluster execute ```sh helm -n k8gb upgrade -i k8gb k8gb/k8gb --create-namespace -f ./docs/examples/ns1/k8gb-cluster-ns1-eu-west-1.yaml ``` In `us-east-1` cluster execute ```sh helm -n k8gb upgrade -i k8gb k8gb/k8gb --create-namespace -f ./docs/examples/ns1/k8gb-cluster-ns1-us-east-1.yaml ``` Create NS1 secret in each cluster ```sh export NS1_APIKEY=<ns1-api-key> make ns1-secret ```