cwielenb/CNCF-Dataset huggingface dataset:
Project: YugabyteDB (App Definition and Development / Database)
File: docs-edit.md

title: Edit the YugabyteDB docs headerTitle: Edit the docs linkTitle: Edit the docs description: Get set up and edit the YugabyteDB docs locally menu: preview: identifier: docs-edit parent: docs weight: 2914 type: docs After you've gotten the docs site , make your changes. If you're going to be doing this a lot, read some . If you need to edit syntax diagrams, see . In your local copy of your `yugabyte-db` fork, make sure your local `master` branch is up to date, and send any changes to GitHub's copy of your fork. ```sh git checkout master git pull upstream master # get up to date with the Yugabyte GitHub repo git push origin # send any changes to your fork on GitHub ``` Next, make a branch. ```sh git checkout -b my-branch-name ``` Find your file(s) in `docs/content/<version>/...` and edit as required. Verify that your changes look good in the live-reload server. If you don't have the docs site running locally, refer to . ```sh npm start ``` Commit your changes. ```sh git commit -A -m "Your commit message here" ``` Push your changes to your fork. ```sh git push origin ``` At this point, you're ready to . If you can, copy an existing page in the location you want the new page to be, and adjust. Adding a new page is similar in most ways to editing an existing page, with the added complexity of sorting out the frontmatter so that the page works correctly in the site, including showing up in the left-side navigation menu. See for more information. More content in this section is forthcoming. After you've made your changes, make a pull request by telling GitHub to compare a branch on your fork to the master branch on the main repository. Preview builds take up to 5 minutes to build. All PR previews on the main repository are of the form `https://deploy-preview-ABCDE--infallible-bardeen-164bc9.netlify.app/` where ABCDE is the pull request number. Optionally, you can tag the Netlify bot in the PR description to tell the bot where to launch the preview. For example, if you changed the page at `docs.yugabyte.com/preview/contribute/docs/docs-edit/` you could add a tag to the PR description as shown in the following illustration: When your reviewer opens the build preview, it will automatically land on the page you specified. Optionally, run a link checker. For example, <https://linkchecker.github.io/linkchecker/>. External contributors If possible, in your PR on GitHub, click Labels, filter on 'doc', and apply the `area/documentation` label. Let us know about your PR in the `#contributors-docs` channel. Internal contributors Under Reviewers set a member of the docs team for review, along with technical reviewers as required. Under Labels, apply the `area/documentation` label to your PR. Let us know about your PR in the `#docs` channel in Slack.
Project: Lagoon (App Definition and Development / Application Definition & Image Build)
File: harbor-database.md

Harbor-Database requires specific environment variables to be set in order to start, which are stored within secrets as described in the `services/harbor-database/harbor-core.yml` file. `POSTGRES_DB`* The default database to be set up when initializing the Postgres service. The default value is `postgres`. `POSTGRES_PASSWORD`* The root password for the Postgres database. The default value is `test123`. This value is retrieved from a secret created when Harbor is first set up on a running Lagoon. `POSTGRES_USER`* The default user to be set up when initializing the Postgres service. The default value is `postgres`.
Project: Couler (Provisioning / Automation & Configuration)
File: couler-tekton-design.md

This document outlines the design of tekton backend for core Couler APIs. Design the tekton backend implementation for core Couler APIs. Provide implementation details. Based on the core , we can see the definitions in different workflow engines. | Couler | Argo | Tekton | | - | - | - | | Step | Step | Step | | Reusable step | Template | Task | | Workflow | Workflow | Pipeline | `Step` is the smallest unit and remain consistent across different backends so the core operation `runstep(stepdef)` will also keep consistent. In tekton, the definition of `step` and `container` keeps the same, which means that if users pass a python function to step, the backend should wrap the function in a python base image automatically. In the latest v0.16 version of Tekton, the condition field is deprecated and Tekton uses instead. Here is an example: ```yaml tasks: name: echo-file-exists when: input: "$(tasks.check-file.results.exists)" operator: in values: ["yes"] taskRef: name: echo-file-exists ``` A `whenExpression` is made of `Input`, `Operator` and `Values`. The `Input` can be static inputs or variables (Parameters or Results in Tekton). The `Operator` can be either `in` or `notin`. As we can see, there is no `else_op` in Tekton, so we need to convert the `else` in the Tekton backend, which is pretty simple since there is only `in` and `notin` operator, we can simply change the operator in the "else" task like: ```yaml tasks: name: echo-file-not-exists when: input: "$(tasks.check-file.results.exists)" operator: notin values: ["yes"] taskRef: name: echo-file-not-exists ``` There is no native support for loops in Tekton for now. See this for more information. The `getstatus`, `getlogs` remains the same as the Argo design. `submit(config=workflow_config(schedule=" * 1"))`: There is no native support for cron in Tekton, see this for more information. The community recommend cronjob in kubernetes, see here. For couler, we can wrap the `cron` in the workflow and let backend to handle the work like create `CronJob` in Kubernetes. `deleteworkflow(workflowname)`: To be discussed: should we delete the tasks when delete the pipeline? `listworkflowrecords(workflow_name)`: After submitting the workflow(create PipelineRun in Tekton), there will be numbers of workflow records. A list function is necessary for users to show all the records. : Finally is a unique feature of Tekton. With finally, the Final tasks are guaranteed to be executed in parallel after all PipelineTasks under tasks have completed regardless of success or error. For example: ```yaml spec: tasks: name: tests taskRef: Name: integration-test finally: name: cleanup-test taskRef: Name: cleanup ``` In Couler, we can have `runfinally(finallydef)` function which is only available when the backend is Tekton.
Project: ClickHouse (App Definition and Development / Database)
File: v21.9.4.35-stable.md

sidebar_position: 1 sidebar_label: 2022 Backported in : Fix segfault while inserting into column with type LowCardinality(Nullable) in Avro input format. (). Do not add const group by key for query with only having. (). Merging (). Fix terminate on uncaught exception ().
Project: Packer (App Definition and Development / Application Definition & Image Build)
File: ssh_or_winrm_times_out.md

name: SSH or WinRM times out about: I have a waiting SSH or WinRM error. labels: communicator-question Got one of the following errors ? See if the related guides can help. `Waiting for WinRM to become available` ? See our basic WinRm Packer guide: https://www.packer.io/guides/automatic-operating-system-installs/autounattend_windows `Waiting for SSH to become available` ? See our basic SSH Packer guide: https://www.packer.io/guides/automatic-operating-system-installs/preseed_ubuntu Issues on GitHub are intended to be related to bugs or feature requests, so we recommend using our other community resources instead of asking here if you have a question. Packer Guides: https://www.packer.io/guides Discussion List: https://groups.google.com/group/packer-tool Any other questions can be sent to the packer section of the HashiCorp forum: https://discuss.hashicorp.com/c/packer Packer community links: https://www.packer.io/community
Project: StarRocks (App Definition and Development / Database)
File: milliseconds_diff.md

displayed_sidebar: "English" Returns the time difference between the start date and end date in milliseconds. This function is supported from v3.2.4. ```Haskell BIGINT milliseconds_diff(DATETIME expr1, DATETIME expr2); ``` `expr1`: the end time. It must be of the DATETIME type. If `expr1` is earlier than `expr2`, a negative value is returned. `expr2`: the start time. It must be of the DATETIME type. Returns a value of the BIGINT type. NULL is returned if the input date does not exist. ```Plain Text select milliseconds_diff('2024-01-25 21:00:00.423','2024-01-25 21:00:00.123'); +-+ | milliseconds_diff('2024-01-25 21:00:00.423', '2024-01-25 21:00:00.123') | +-+ | 300 | +-+ select milliseconds_diff('2024-01-25 21:00:01', '2024-01-25 21:00:00'); +--+ | milliseconds_diff('2024-01-25 21:00:01', '2024-01-25 21:00:00') | +--+ | 1000 | +--+ select milliseconds_diff('2024-01-25 00:00:01', '2024-01-25'); +--+ | milliseconds_diff('2024-01-25 00:00:01', '2024-01-25') | +--+ | 1000 | +--+ ```
Project: KICS (Provisioning / Security & Compliance)
File: d7b9d850-3e06-4a75-852f-c46c2e92240b.md

title: Hardcoded AWS Access Key hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: d7b9d850-3e06-4a75-852f-c46c2e92240b Query name: Hardcoded AWS Access Key Platform: Terraform Severity: <span style="color:#bb2124">High</span> Category: Secret Management URL: AWS Access Key should not be hardcoded<br> ```tf title="Positive test num. 1 - tf file" hl_lines="13" module "ec2_instance" { source = "terraform-aws-modules/ec2-instance/aws" version = "~> 3.0" name = "single-instance" ami = "ami-ebd02392" instance_type = "t2.micro" key_name = "user1" monitoring = true vpcsecuritygroup_ids = ["sg-12345678"] subnet_id = "subnet-eddcdzz4" user_data = "1234567890123456789012345678901234567890$" tags = { Terraform = "true" Environment = "dev" } } ``` ```tf title="Positive test num. 2 - tf file" hl_lines="5" resource "aws_instance" "positive1" { ami = data.aws_ami.ubuntu.id instance_type = "t3.micro" user_data = "1234567890123456789012345678901234567890$" tags = { Name = "HelloWorld" } } ``` ```tf title="Negative test num. 1 - tf file" module "ec2_instance" { source = "terraform-aws-modules/ec2-instance/aws" version = "~> 3.0" name = "single-instance" ami = "ami-ebd02392" instance_type = "t2.micro" key_name = "user1" monitoring = true vpcsecuritygroup_ids = ["sg-12345678"] subnet_id = "subnet-eddcdzz4" user_data = file("scripts/first-boot-http.sh") tags = { Terraform = "true" Environment = "dev" } } ``` ```tf title="Negative test num. 2 - tf file" resource "aws_instance" "negative1" { ami = data.aws_ami.ubuntu.id instance_type = "t3.micro" user_data = file("scripts/first-boot-http.sh") tags = { Name = "HelloWorld" } } ```
Project: Chef InSpec (Provisioning / Security & Compliance)
File: google_compute_vpn_tunnels.md

+++ title = "googlecomputevpn_tunnels resource" draft = false gh_repo = "inspec" platform = "gcp" [menu] [menu.inspec] title = "googlecomputevpn_tunnels" identifier = "inspec/resources/gcp/googlecomputevpntunnels.md googlecomputevpntunnels resource" parent = "inspec/resources/gcp" +++ A `googlecomputevpn_tunnels` is used to test a Google VpnTunnel resource This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource ```ruby describe googlecomputevpn_tunnels(project: 'chef-gcp-inspec', region: 'europe-west2') do its('vpntunnelnames') { should include 'inspec-vpn-tunnel' } its('peer_ips') { should include '15.0.0.120' } end ``` describe googlecomputevpn_tunnels(project: 'chef-inspec-gcp', region: 'europe-west2') do its('count') { should be <= 100} end describe googlecomputevpn_tunnels(project: 'chef-inspec-gcp', region: 'europe-west2') do its('vpntunnelnames') { should include "vpn_tunnel-name" } end describe googlecomputevpn_tunnels(project: 'chef-inspec-gcp', region: 'europe-west2') do its('vpntunneltargetvpngateways') { should not include "gateway-name" } end Properties that can be accessed from the `googlecomputevpn_tunnels` resource: See the resource for more information. `ids` : an array of `googlecomputevpn_tunnel` id `creation_timestamps` : an array of `googlecomputevpntunnel` creationtimestamp `vpntunnelnames` : an array of `googlecomputevpn_tunnel` name `descriptions` : an array of `googlecomputevpn_tunnel` description `targetvpngateways` : an array of `googlecomputevpntunnel` targetvpn_gateway `vpn_gateways` : (Beta only) an array of `googlecomputevpntunnel` vpngateway `vpngatewayinterfaces` : (Beta only) an array of `googlecomputevpntunnel` vpngateway_interface `peerexternalgateways` : (Beta only) an array of `googlecomputevpntunnel` peerexternal_gateway `peerexternalgateway_interfaces` : (Beta only) an array of `googlecomputevpntunnel` peerexternalgatewayinterface `peergcpgateways` : (Beta only) an array of `googlecomputevpntunnel` peergcp_gateway `routers` : an array of `googlecomputevpn_tunnel` router `peer_ips` : an array of `googlecomputevpntunnel` peerip `shared_secrets` : an array of `googlecomputevpntunnel` sharedsecret `sharedsecrethashes` : an array of `googlecomputevpntunnel` sharedsecret_hash `ike_versions` : an array of `googlecomputevpntunnel` ikeversion `localtrafficselectors` : an array of `googlecomputevpntunnel` localtraffic_selector `remotetrafficselectors` : an array of `googlecomputevpntunnel` remotetraffic_selector `labels` : (Beta only) an array of `googlecomputevpn_tunnel` labels `label_fingerprints` : (Beta only) an array of `googlecomputevpntunnel` labelfingerprint `regions` : an array of `googlecomputevpn_tunnel` region 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: Cyclops (App Definition and Development / Application Definition & Image Build)
File: manifest.md

sidebar_label: Using kubectl To install Cyclops in your cluster, run commands below: ```bash kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.5.0/install/cyclops-install.yaml && kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.5.0/install/demo-templates.yaml ``` It will create a new namespace called `cyclops` and deploy everything you need for your Cyclops instance to run. Now all that is left is to expose Cyclops server outside the cluster: ```bash kubectl port-forward svc/cyclops-ui 3000:3000 -n cyclops ``` You can now access Cyclops in your browser on .
Project: SlimToolkit (Provisioning / Security & Compliance)
File: RELEASE.md

The `yaml` Project is released on an as-needed basis. The process is as follows: An issue is proposing a new release with a changelog since the last release All must LGTM this release An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION` The release issue is closed An announcement email is sent to `kubernetes-dev@googlegroups.com` with the subject `[ANNOUNCE] kubernetes-template-project $VERSION is released`
Project: KubeDB by AppsCode (App Definition and Development / Database)
File: CHANGELOG-v2023.12.1-rc.1.md

title: Changelog | KubeDB description: Changelog menu: docs_{{.version}}: identifier: changelog-kubedb-v2023.12.1-rc.1 name: Changelog-v2023.12.1-rc.1 parent: welcome weight: 20231201 product_name: kubedb menuname: docs{{.version}} sectionmenuid: welcome url: /docs/{{.version}}/welcome/changelog-v2023.12.1-rc.1/ aliases: /docs/{{.version}}/CHANGELOG-v2023.12.1-rc.1/ Update kubestash apimachienry Add default KubeBuilder client (#1081) Add SecurityContext field in catalogs; Set default accordingly (#1080) Prepare for release v0.23.0-rc.1 (#159) Prepare for release v0.38.0-rc.1 (#738) Prepare for release v0.14.0-rc.1 (#86) Prepare for release v0.38.0-rc.1 (#680) Prepare for release v0.1.0-rc.1 (#9) Prepare for release v2023.12.1-rc.1 (#727) Add `runAsUser` field in all catalogs (#725) Add `--default-seccomp-profile-type` flag (#724) Add `databases` flag for mysql addon (#723) Add postgres restic addon (#726) Prepare for release v0.9.0-rc.1 (#50) Set default KubeBuilder client (#49) Prepare for release v0.1.0-rc.1 (#29) Prepare for release v0.22.0-rc.1 (#235) Pass version in SetDefaults func (#234) Prepare for release v0.1.0-rc.1 (#4) Prepare for release v0.18.0-rc.1 (#93) Prepare for release v0.31.0-rc.1 (#406) Prepare for release v0.31.0-rc.1 (#582) Prepare for release v0.1.0-rc.1 (#4) Prepare for release v0.1.0-rc.1 (#14) Prepare for release v0.31.0-rc.1 (#574) Pass version in SetDefaults func (#573) Prepare for release v0.1.0-rc.1 (#3) Prepare for release v0.16.0-rc.1 (#90) Prepare for release v0.1.0-rc.1 (#13) Add `databases` flag (#12) Prepare for release v0.25.0-rc.1 (#494) Prepare for release v0.25.0-rc.1 (#333) Pass version in SetDefaults func (#332) Prepare for release v0.11.0-rc.1 (#50) Prepare for release v0.22.0-rc.1 (#140) Prepare for release v0.25.0-rc.1 (#297) Prepare for release v0.38.0-rc.1 (#685) Prepare for release v0.1.0-rc.1 (#7) Prepare for release v0.1.0-rc.1 (#6) Refactor (#5) Prepare for release v0.38.0-rc.1 (#61) Ensure archiver CRDs (#60) Prepare for release v0.25.0-rc.1 (#314) Prepare for release v0.31.0-rc.1 (#497) Pass version in SetDefaults func (#496) Prepare for release v0.17.0-rc.1 (#81) Prepare for release v0.1.0-rc.1 (#10) Prepare for release v0.25.0-rc.1 (#245) Prepare for release v0.14.0-rc.1 (#86) Prepare for release v0.23.0-rc.1 (#272) Fix kafka restart-pods test (#271) Prepare for release v0.14.0-rc.1 (#95) Prepare for release v0.14.0-rc.1 (#72) Initialize default KubeBuilder client (#71)
Project: DevSpace (App Definition and Development / Application Definition & Image Build)
File: yaml_docs.md

Generating yaml files 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.GenYamlTree(cmd, "/tmp") if err != nil { log.Fatal(err) } } ``` That will get you a Yaml document `/tmp/test.yaml` This program can actually generate docs for the kubectl command in the kubernetes project ```go package main import ( "io/ioutil" "log" "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.GenYamlTree(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 `GenYaml` instead of `GenYamlTree` ```go out := new(bytes.Buffer) doc.GenYaml(cmd, out) ``` This will write the yaml doc for ONLY "cmd" into the out, buffer. Both `GenYaml` and `GenYamlTree` have alternate versions with callbacks to get some control of the output: ```go func GenYamlTreeCustom(cmd *Command, dir string, filePrepender, linkHandler func(string) string) error { //... } ``` ```go func GenYamlCustom(cmd Command, out bytes.Buffer, linkHandler func(string) string) error { //... } ``` The `filePrepender` will prepend the return value given the full filepath to the rendered Yaml 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: KICS (Provisioning / Security & Compliance)
File: 5061f84c-ab66-4660-90b9-680c9df346c0.md

title: Nifcloud ELB Has Common Private Network hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 5061f84c-ab66-4660-90b9-680c9df346c0 Query name: Nifcloud ELB Has Common Private Network Platform: Terraform Severity: <span style="color:#edd57e">Low</span> Category: Networking and Firewall URL: The elb has common private network<br> ```tf title="Positive test num. 1 - tf file" hl_lines="1" resource "nifcloud_elb" "positive" { availability_zone = "east-11" instance_port = 80 protocol = "HTTP" lb_port = 80 network_interface { networkid = "net-COMMONPRIVATE" } } ``` ```tf title="Positive test num. 2 - tf file" hl_lines="1" resource "nifcloud_elb" "positive" { availability_zone = "east-11" instance_port = 80 protocol = "HTTP" lb_port = 80 network_interface { networkid = "net-COMMONGLOBAL" } network_interface { networkid = "net-COMMONPRIVATE" } } ``` ```tf title="Negative test num. 1 - tf file" resource "nifcloud_elb" "negative" { availability_zone = "east-11" instance_port = 80 protocol = "HTTP" lb_port = 80 network_interface { networkid = nifcloudprivate_lan.main.id } } ```
Project: KICS (Provisioning / Security & Compliance)
File: 895a5a95-3756-4b04-9924-2f3bc93181bd.md

title: Etcd TLS Certificate Not Properly Configured hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 895a5a95-3756-4b04-9924-2f3bc93181bd Query name: Etcd TLS Certificate Not Properly Configured Platform: Kubernetes Severity: <span style="color:#ff7213">Medium</span> Category: Networking and Firewall URL: When using kube-apiserver commands, the '--etcd-certfile' and '--etcd-keyfile' flags should be defined<br> ```yaml title="Positive test num. 1 - yaml file" hl_lines="11" apiVersion: v1 kind: Pod metadata: name: command-demo labels: purpose: demonstrate-command spec: containers: name: command-demo-container image: gcr.io/google_containers/kube-apiserver-amd64:v1.6.0 command: ["kube-apiserver"] args: ["--etcd-keyfile=/path/to/key/file.key"] restartPolicy: OnFailure ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="11" apiVersion: v1 kind: Pod metadata: name: command-demo labels: purpose: demonstrate-command spec: containers: name: command-demo-container image: gcr.io/google_containers/kube-apiserver-amd64:v1.6.0 command: ["kube-apiserver"] args: ["--etcd-certfile=/path/to/cert/file.crt"] restartPolicy: OnFailure ``` ```yaml title="Negative test num. 1 - yaml file" apiVersion: v1 kind: Pod metadata: name: command-demo labels: purpose: demonstrate-command spec: containers: name: command-demo-container image: gcr.io/google_containers/kube-apiserver-amd64:v1.6.0 command: ["kube-apiserver"] args: ["--etcd-keyfile=/path/to/key/file.key","--etcd-certfile=/path/to/cert/file.crt"] restartPolicy: OnFailure ``` ```yaml title="Negative test num. 2 - yaml file" apiVersion: v1 kind: Pod metadata: name: command-demo labels: purpose: demonstrate-command spec: containers: name: command-demo-container image: gcr.io/google_containers/kube-apiserver-amd64:v1.6.0 command: ["kube-apiserver","--etcd-keyfile=/path/to/key/file.key","--etcd-certfile=/path/to/cert/file.crt"] args: [] restartPolicy: OnFailure ```