set initial values #2882
set initial values #2882
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -1,22 +1,38 @@ | |||
| # Managing Custom License Fields | |||
| # Managing Customer License Fields | |||
There was a problem hiding this comment.
^ Updated this topic so that it's about managing all types of license fields from the License Fields tab in the Vendor Portal in general. Meaning, the new steps about how to set initial values for built-in fields are moved over to this topic. Previously, this topic just had info about custom fields.
The idea is that you can go to one page in the docs for info about the License Fields Vendor Portal page
| import GitOpsNotRecommended from "../partials/gitops/_gitops-not-recommended.mdx" | ||
|
|
||
| # Built-in License Fields | ||
| # Built-In License Fields |
There was a problem hiding this comment.
Updated this topic to clarify that it's talking about the fields in the license itself. NOT the fields that show up in the Vendor Portal.
There is of course some cross-over in those lists of fields, but the purpose of this page is to show vendors the field names that they can access using the KOTS License context template functions or the SDK API license endpoints
| Built-in fields are reserved field names. The following table describes each built-in license field that you can define for a customer. | ||
| This topic describes the built-in license fields that appear customer licenses for applications distributed with Replicated. | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Added this conceptual overview to explain what these fields can be used for
| <tr> | ||
| <td>`replicatedProxyDomain`</td> | ||
| <td>The domain used for the Replicated proxy registry. By default, `proxy.replicated.com`. For information about setting a custom domain for the proxy registry, see [Using Custom Domains](/vendor/custom-domains-using).</td> | ||
| </tr> |
There was a problem hiding this comment.
^ I saw this proxy domain field in some licenses that I downloaded from the Vendor Portal, but it was missing from the table. Not sure if it was worth including here but added it just in case
There was a problem hiding this comment.
replicatedProxyDomain won't work. That value is sort of accessible via the LocalImageName function, but that's not relevant here I think. The full list of supported values for LicenseFieldValue is here: https://github.com/replicatedhq/kots/blob/d39bb2bc190c767842cde3620363de100bb5c70c/pkg/template/license_context.go#L41-L74
There was a problem hiding this comment.
and default case in that code covers vendor defined entitlements, with expires_at being the exception that we generate (thus the snake case)
There was a problem hiding this comment.
Gotcha, thanks. I'll remove the proxy domain field from this table
There was a problem hiding this comment.
And from that list that you linked, it looks like just isDisasterRecoverySupported is missing...which I think is talking about the EC disaster recovery field
There was a problem hiding this comment.
Yeah. That list definitely needs to be updated.
| type: 'category', | ||
| label: 'Querying License Entitlements', | ||
| items: [ | ||
| 'vendor/licenses-using-builtin-fields', |
There was a problem hiding this comment.
^ Moved the Built-In License Fields page to the section on querying license fields, where it is applicable
| { | ||
| type: 'category', | ||
| label: 'Customer Licenses', | ||
| label: 'Customers and Licenses', |
There was a problem hiding this comment.
^ clarifying that customers and licenses are two different things
Steps on how to set initial values moved to the "Managing Customer License Fields" docs page, which includes all the info about stuff you can do on the License Fields page in the Vendor Portal: https://deploy-preview-2882--replicated-docs-upgrade.netlify.app/vendor/licenses-adding-custom-fields. Note this draws distinction between the built-in fields for customers in the Vendor Portal, and the built-in fields that appear in licenses
"Built-In License Fields" docs page (with the tables of field names) is updated to clarify that these are the fields that appear in the license itself: https://deploy-preview-2882--replicated-docs-upgrade.netlify.app/vendor/licenses-using-builtin-fields