Skip to content

Commit

Permalink
Rename kpt function to config function
Browse files Browse the repository at this point in the history
  • Loading branch information
prachirp committed Jun 24, 2020
1 parent e97fd38 commit 58c7dec
Show file tree
Hide file tree
Showing 35 changed files with 86 additions and 86 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/architecture/index.html
Expand Up @@ -570,7 +570,7 @@ <h3 id="targets">Targets</h3>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/7bf1a36d19747d493ad7972c23b53c7070f7ae57">Transfer kpt-functions sdk and catalog docs to kpt (7bf1a36d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
10 changes: 5 additions & 5 deletions docs/concepts/functions/index.html
Expand Up @@ -354,7 +354,7 @@
<h1>Functions</h1>
<div class="lead">Functions goals and specification</div>
<h2 id="introduction">Introduction</h2>
<p>KPT Functions are client-side programs that make it easy to operate on a repository of Kubernetes configuration files.</p>
<p>Config Functions are client-side programs that make it easy to operate on a repository of Kubernetes configuration files.</p>
<p>Use cases:</p>
<ul>
<li><strong>Configuration Validation:</strong> e.g. Require all <code>Namespace</code> configurations to have a <code>cost-center</code> label.</li>
Expand All @@ -363,9 +363,9 @@ <h2 id="introduction">Introduction</h2>
security posture.</li>
</ul>
<img src="https://storage.googleapis.com/kpt-functions/docs/run.gif">
<p>KPT functions can be run locally or as part of a CI/CD pipeline.</p>
<p>In GitOps workflows, KPT functions read and write configuration files from a Git repo. Changes
to the system authored by humans and mutating KPT functions are reviewed before being committed to the repo. KPT functions
<p>Config functions can be run locally or as part of a CI/CD pipeline.</p>
<p>In GitOps workflows, config functions read and write configuration files from a Git repo. Changes
to the system authored by humans and mutating config functions are reviewed before being committed to the repo. Config functions
can be run as pre-commit or post-commit steps to validate configurations before they are applied to a cluster.</p>
<h2 id="why-functions">Why Functions</h2>
<p>We build functions using the same <a href="../architecture/#influences">architecture influences</a> as the rest of kpt, specifically:</p>
Expand Down Expand Up @@ -442,7 +442,7 @@ <h2 id="next-steps">Next Steps</h2>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/7bf1a36d19747d493ad7972c23b53c7070f7ae57">Transfer kpt-functions sdk and catalog docs to kpt (7bf1a36d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/contact/index.html
Expand Up @@ -254,7 +254,7 @@ <h1>Contact</h1>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/95d57f4dc97db1fc08e130c6a9fa8030fe3041ab">Add Contacts page with a link to the Slack channel (95d57f4d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/faq/index.html
Expand Up @@ -329,7 +329,7 @@ <h3 id="next-steps">Next Steps</h3>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 11, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/95d57f4dc97db1fc08e130c6a9fa8030fe3041ab">Add Contacts page with a link to the Slack channel (95d57f4d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consumer/function/catalog/catalog/index.js
Expand Up @@ -24,7 +24,7 @@ linkTitle: "Functions Catalog"
weight: 8
type: docs
description: >
Catalog of kpt functions.
Catalog of Config Functions.
---
<!---
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consumer/function/catalog/catalog/package.json
@@ -1,7 +1,7 @@
{
"name": "kpt-functions-catalog-docs",
"version": "0.1.0",
"description": "Generate docs for KPT functions catalog",
"description": "Generate docs for config functions catalog",
"author": "KPT Authors",
"license": "Apache-2.0",
"main": "index.js",
Expand Down
Expand Up @@ -25,11 +25,11 @@
" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://googlecontainertools.github.io/kpt/guides/consumer/function/catalog/docs/helm-template/usage/" />
<meta property="article:modified_time" content="2020-06-19T15:07:12-04:00" /><meta property="og:site_name" content="Kpt" />
<meta property="article:modified_time" content="2020-06-24T17:55:03-05:00" /><meta property="og:site_name" content="Kpt" />
<meta itemprop="name" content="Helm-template Usage">
<meta itemprop="description" content="Helm-template Usage.
">
<meta itemprop="dateModified" content="2020-06-19T15:07:12-04:00" />
<meta itemprop="dateModified" content="2020-06-24T17:55:03-05:00" />
<meta itemprop="wordCount" content="408">


Expand Down Expand Up @@ -955,7 +955,7 @@
<h1>Helm-template Usage</h1>
<div class="lead">Helm-template Usage.</div>
<h2 id="using-helm-template">Using helm-template</h2>
<p>Kpt packages are just configuration so any solution, like the <code>helm template</code> command, which emits configuration can also be used to generate kpt packages. The <code>helm-template</code> kpt function generates a new kpt package from a local Helm chart or upserts Helm chart configuration to an existing kpt package. In the context of a pipeline, these packages can then be further customized using other kpt functions.</p>
<p>Kpt packages are just configuration so any solution, like the <code>helm template</code> command, which emits configuration can also be used to generate kpt packages. The <code>helm-template</code> config function generates a new kpt package from a local Helm chart or upserts Helm chart configuration to an existing kpt package. In the context of a pipeline, these packages can then be further customized using other config functions.</p>
<h2 id="examples">Examples</h2>
<h3 id="example-1-hello-world">Example 1: Hello World</h3>
<h4 id="hello-world-prerequisites">Hello World: Prerequisites</h4>
Expand Down Expand Up @@ -1036,7 +1036,7 @@ <h3 id="how-can-i-set-arbitrary-values-in-my-chart">How can I set arbitrary valu
</code></pre></div>


<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/7bf1a36d19747d493ad7972c23b53c7070f7ae57">Transfer kpt-functions sdk and catalog docs to kpt (7bf1a36d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
10 changes: 5 additions & 5 deletions docs/guides/consumer/function/catalog/index.html
Expand Up @@ -22,16 +22,16 @@
<link rel="icon" type="image/png" href="/kpt/favicons/android-192x192.png" sizes="192x192">

<title>Functions Catalog | Kpt</title><meta property="og:title" content="Functions Catalog" />
<meta property="og:description" content="Catalog of kpt functions.
<meta property="og:description" content="Catalog of Config Functions.
" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://googlecontainertools.github.io/kpt/guides/consumer/function/catalog/" />
<meta property="og:site_name" content="Kpt" />
<meta itemprop="name" content="Functions Catalog">
<meta itemprop="description" content="Catalog of kpt functions.
<meta itemprop="description" content="Catalog of Config Functions.
"><meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Functions Catalog"/>
<meta name="twitter:description" content="Catalog of kpt functions.
<meta name="twitter:description" content="Catalog of Config Functions.
"/>


Expand Down Expand Up @@ -932,7 +932,7 @@

<div class="td-content">
<h1>Functions Catalog</h1>
<div class="lead">Catalog of kpt functions.</div>
<div class="lead">Catalog of Config Functions.</div>
<!---
DO NOT EDIT. Generated by: "cd catalog; npm run gen-docs"
-->
Expand Down Expand Up @@ -1281,7 +1281,7 @@ <h5>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/4be5d836e58fc37df9edf072ac187c45cfca5c8f">Add structured results section and link to toolchain used to make catalog functions (4be5d836)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consumer/function/catalog/index.xml
Expand Up @@ -23,7 +23,7 @@


&lt;h2 id=&#34;using-helm-template&#34;&gt;Using helm-template&lt;/h2&gt;
&lt;p&gt;Kpt packages are just configuration so any solution, like the &lt;code&gt;helm template&lt;/code&gt; command, which emits configuration can also be used to generate kpt packages. The &lt;code&gt;helm-template&lt;/code&gt; kpt function generates a new kpt package from a local Helm chart or upserts Helm chart configuration to an existing kpt package. In the context of a pipeline, these packages can then be further customized using other kpt functions.&lt;/p&gt;
&lt;p&gt;Kpt packages are just configuration so any solution, like the &lt;code&gt;helm template&lt;/code&gt; command, which emits configuration can also be used to generate kpt packages. The &lt;code&gt;helm-template&lt;/code&gt; config function generates a new kpt package from a local Helm chart or upserts Helm chart configuration to an existing kpt package. In the context of a pipeline, these packages can then be further customized using other config functions.&lt;/p&gt;
&lt;h2 id=&#34;examples&#34;&gt;Examples&lt;/h2&gt;
&lt;h3 id=&#34;example-1-hello-world&#34;&gt;Example 1: Hello World&lt;/h3&gt;
&lt;h4 id=&#34;hello-world-prerequisites&#34;&gt;Hello World: Prerequisites&lt;/h4&gt;
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/consumer/function/index.html
Expand Up @@ -960,7 +960,7 @@ <h2 id="calling-functions-imperatively">Calling Functions Imperatively</h2>
this information to a container running <code>gcr.io/kpt-functions/label-namespace</code>, and wrote the resources
back to the package.</p>
<h2 id="calling-functions-declaratively">Calling Functions Declaratively</h2>
<p>The most common way of invoking kpt functions in production will be the <a href="../../../reference/fn/run/#declaratively-run-one-or-more-functions">declarative method</a>.</p>
<p>The most common way of invoking config functions in production will be the <a href="../../../reference/fn/run/#declaratively-run-one-or-more-functions">declarative method</a>.</p>
<p>Let&rsquo;s run the same <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/hello-world/src/label_namespace.ts">label-namespace</a> function declaratively, which means we make a reusable function
configuration resource which contains all information necessary to run the function, from container
image to argument values. Once we create file with this information we can check it into <a href="https://en.wikipedia.org/wiki/Version_control">VCS</a> and
Expand Down Expand Up @@ -1068,7 +1068,7 @@ <h5>
<h5>
<a href="/kpt/guides/consumer/function/catalog/">Functions Catalog</a>
</h5>
<p>Catalog of kpt functions.</p>
<p>Catalog of Config Functions.</p>
</div>


Expand All @@ -1083,7 +1083,7 @@ <h5>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/4be5d836e58fc37df9edf072ac187c45cfca5c8f">Add structured results section and link to toolchain used to make catalog functions (4be5d836)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consumer/function/pipeline/index.html
Expand Up @@ -1066,7 +1066,7 @@ <h3 id="example">Example</h3>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/7bf1a36d19747d493ad7972c23b53c7070f7ae57">Transfer kpt-functions sdk and catalog docs to kpt (7bf1a36d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consumer/index.xml
Expand Up @@ -929,7 +929,7 @@ parsed the arguments and provided them through a functionConfig field along with
this information to a container running &lt;code&gt;gcr.io/kpt-functions/label-namespace&lt;/code&gt;, and wrote the resources
back to the package.&lt;/p&gt;
&lt;h2 id=&#34;calling-functions-declaratively&#34;&gt;Calling Functions Declaratively&lt;/h2&gt;
&lt;p&gt;The most common way of invoking kpt functions in production will be the &lt;a href=&#34;../../../reference/fn/run/#declaratively-run-one-or-more-functions&#34;&gt;declarative method&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;The most common way of invoking config functions in production will be the &lt;a href=&#34;../../../reference/fn/run/#declaratively-run-one-or-more-functions&#34;&gt;declarative method&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Let&amp;rsquo;s run the same &lt;a href=&#34;https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/master/ts/hello-world/src/label_namespace.ts&#34;&gt;label-namespace&lt;/a&gt; function declaratively, which means we make a reusable function
configuration resource which contains all information necessary to run the function, from container
image to argument values. Once we create file with this information we can check it into &lt;a href=&#34;https://en.wikipedia.org/wiki/Version_control&#34;&gt;VCS&lt;/a&gt; and
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/ecosystem/oam/index.html
Expand Up @@ -1128,7 +1128,7 @@ <h3 id="live-apply">Live apply</h3>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 7, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/9fee402604a997997b7c7e823366249f2d1c36ff">Updates the kpt generated docs with new flag info (9fee4026)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down
12 changes: 6 additions & 6 deletions docs/guides/producer/functions/index.html
Expand Up @@ -22,16 +22,16 @@
<link rel="icon" type="image/png" href="/kpt/favicons/android-192x192.png" sizes="192x192">

<title>Functions | Kpt</title><meta property="og:title" content="Functions" />
<meta property="og:description" content="Writing kpt functions to generated, transform, and validate resources.
<meta property="og:description" content="Writing config functions to generated, transform, and validate resources.
" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://googlecontainertools.github.io/kpt/guides/producer/functions/" />
<meta property="og:site_name" content="Kpt" />
<meta itemprop="name" content="Functions">
<meta itemprop="description" content="Writing kpt functions to generated, transform, and validate resources.
<meta itemprop="description" content="Writing config functions to generated, transform, and validate resources.
"><meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Functions"/>
<meta name="twitter:description" content="Writing kpt functions to generated, transform, and validate resources.
<meta name="twitter:description" content="Writing config functions to generated, transform, and validate resources.
"/>


Expand Down Expand Up @@ -939,12 +939,12 @@

<div class="td-content">
<h1>Functions</h1>
<div class="lead">Writing kpt functions to generated, transform, and validate resources.</div>
<div class="lead">Writing config functions to generated, transform, and validate resources.</div>
<h2 id="functions-developer-guide">Functions Developer Guide</h2>
<p>Kpt functions are conceptually similar to Kubernetes <em>controllers</em> and <em>validating webhooks</em> &ndash;
<p>Config functions are conceptually similar to Kubernetes <em>controllers</em> and <em>validating webhooks</em> &ndash;
they are programs which read resources as input, then write resources as output (creating,
modifying, deleting, or validating resources).</p>
<p>Unlike controllers and validating webhooks, kpt functions can be run outside of the Kubernetes
<p>Unlike controllers and validating webhooks, config functions can be run outside of the Kubernetes
control plane. This allows them to run in more contexts or embedded in other systems.
For example, functions could be:</p>
<ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/producer/functions/index.xml
Expand Up @@ -487,12 +487,12 @@ will exit non-0. Otherwise it will exit 0.&lt;/p&gt;
<description>


&lt;p&gt;We provide an opinionated Typescript SDK for implementing KPT Functions. This provides various
&lt;p&gt;We provide an opinionated Typescript SDK for implementing config functions. This provides various
advantages:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;General-purpose language:&lt;/strong&gt; Domain-Specific Languages begin their life with a reasonable
feature set, but often grow over time. They bloat in order to accommodate the tremendous variety
of customer use cases. Rather than follow this same course, KPT functions employ a true,
of customer use cases. Rather than follow this same course, config functions employ a true,
general-purpose programming language that provides:
&lt;ul&gt;
&lt;li&gt;Proper abstractions and language features&lt;/li&gt;
Expand All @@ -510,7 +510,7 @@ files. It provides the scaffolding required to develop, build, test, and publish
allowing you to focus on implementing your business-logic.&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;developer-quickstart&#34;&gt;Developer Quickstart&lt;/h2&gt;
&lt;p&gt;This quickstart will get you started developing a KPT Function with the TypeScript SDK,
&lt;p&gt;This quickstart will get you started developing a config function with the TypeScript SDK,
using an existing Hello World package.&lt;/p&gt;
&lt;h3 id=&#34;prerequisites&#34;&gt;Prerequisites&lt;/h3&gt;
&lt;h4 id=&#34;system-requirements&#34;&gt;System Requirements&lt;/h4&gt;
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/producer/functions/ts/develop/index.html
Expand Up @@ -950,7 +950,7 @@
<div class="td-content">
<h1>TypeScript Developer Guide</h1>
<div class="lead">Developing functions in TypeScript.</div>
<p>This guide will walk you through developing a KPT function using the Typescript SDK.</p>
<p>This guide will walk you through developing a config function using the Typescript SDK.</p>
<h2 id="setup">Setup</h2>
<h3 id="system-requirements">System Requirements</h3>
<p>Currently supported platforms: amd64 Linux/Mac</p>
Expand Down Expand Up @@ -1023,7 +1023,7 @@ <h4 id="using-a-gke-cluster">Using a GKE cluster</h4>
<ol>
<li>
<p><code>package.json</code>: The <code>kpt-functions</code> framework library is the only item declared in <code>dependencies</code>.
Everything required to compile and test your KPT function is declared as <code>devDependencies</code>,
Everything required to compile and test your config function is declared as <code>devDependencies</code>,
including the <code>create-kpt-functions</code> CLI discussed later in the <code>README</code>.</p>
</li>
<li>
Expand Down Expand Up @@ -1176,7 +1176,7 @@ <h2 id="implement-the-function">Implement the function</h2>



<div class="text-muted mt-5 pt-3 border-top">Last modified June 19, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/7bf1a36d19747d493ad7972c23b53c7070f7ae57">Transfer kpt-functions sdk and catalog docs to kpt (7bf1a36d)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified June 24, 2020: <a href="https://github.com/GoogleContainerTools/kpt/commit/e97fd3815e38a1a9c6fc33db1936b6a027063acd">Clarify links, add functions to catalog (e97fd381)</a>
</div>
</div>

Expand Down

0 comments on commit 58c7dec

Please sign in to comment.