-
Notifications
You must be signed in to change notification settings - Fork 171
add template submit and copy docs #2263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shaynesf5
wants to merge
4
commits into
main
Choose a base branch
from
shaynes/add-template-submit-copy-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1b6e745
add template submit and copy docs
shaynesf5 140e5ce
None/add template submit copy docs jtg (#2267)
JTorreG a521c9b
Simplify and correct submit and copy template instructions
shaynesf5 4492990
Merge branch 'main' into shaynes/add-template-submit-copy-docs
JTorreG File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
...t/nginx-one-console/nginx-configs/config-templates/submit-and-copy-templates.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| f5-content-type: how-to | ||
| f5-docs: DOCS-000 | ||
| f5-product: NGINX One Console | ||
| title: Submit and copy templates from the Templates list | ||
| description: "Use the Submit and Make a Copy row actions on the Templates list to submit or copy config templates without API calls." | ||
| toc: true | ||
| weight: 150 | ||
| f5-keywords: "templates list, config templates, NGINX One Console, submit template, Submit Template panel, make a copy, copy a template, template submission, base template, augment template" | ||
| f5-summary: > | ||
| Use the Submit and Make a Copy row actions on the Templates list to work with config templates. | ||
| These actions offer a guided UI, instead of the Templates API. | ||
| Select Submit to open the Submit Template panel. Select a base template, enter parameter values, add optional augment templates, select a target, and preview the configuration. | ||
| Select Make a Copy to create a new draft template from the latest version of an existing template. | ||
| f5-audience: operator | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| The Templates list in NGINX One Console has two row actions: **Submit** and **Make a Copy**. Use these actions to work with config templates instead of building Templates API requests by hand. | ||
|
|
||
| Select **Submit** on a finalized base template to open the **Submit Template** panel. The panel guides you through filling in parameter values. You can preview the rendered NGINX configuration before you save. | ||
|
|
||
| Select **Make a Copy** on any template to create a new draft template from its latest version. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| Before you begin, make sure you have: | ||
|
|
||
| - NGINX One Console access: You need template write permission to use the **Submit** and **Make a Copy** row actions. | ||
| - An imported template: At least one template must exist in **Manage** > **Config Templates**. If you don't have any templates yet, import one first. See [Import templates]({{< ref "import-templates.md" >}}) for instructions. | ||
| - A finalized base template: To use **Submit**, you need at least one base template in the `final` state. | ||
|
|
||
| ## Submit a template | ||
|
|
||
| The **Submit** option is available for templates of type `base` that are in the `final` state. | ||
|
|
||
| 1. Go to **Manage** > **Config Templates**. The **Templates** list opens and shows every imported template with its available row actions, as well as F5-provided templates. | ||
| 1. Select **Submit** on a base template that's in the `final` state to create a template submission from the Templates list. | ||
| 1. Fill in the parameter values for the base template. | ||
| 1. Preview the rendered NGINX configuration. | ||
| 1. Select **Save** to create the submission and publish it to your chosen targets. | ||
|
|
||
| ## Edit an existing submission | ||
|
|
||
| You can also use the **Edit Template Submission** panel to edit an existing submission. Open the submission from the **Submissions** section on the Template Detail page. | ||
|
|
||
| ## Copy a template | ||
|
|
||
| The **Make a Copy** option is available for any template, regardless of its type or state. It creates a new draft template from the latest version of the selected template. | ||
|
|
||
| 1. Go to **Manage** > **Config Templates**. The **Templates** list opens and shows every imported template with its available row actions. | ||
| 1. Select **Make a Copy** on the template you want to copy. | ||
| 1. Fill in the name and description for the new template copy. | ||
|
|
||
| NGINX One Console creates a new draft template at version 1. It copies the files, template type, and context configuration from the source template. | ||
|
|
||
| ## What happens next | ||
|
|
||
| After you submit or copy a template, view the result on the [Template Detail page]({{< ref "template-detail-view.md" >}}). Submissions appear in the Submissions section for the submitted template. | ||
|
|
||
| ## API reference | ||
|
|
||
| The Templates list row actions use the following API operations: | ||
|
|
||
| - **Submit**: Uses the [Submit Templates]({{< ref "submit-templates.md" >}}) API to create or update a template submission. | ||
| - **Make a Copy**: Uses the [Copy a template]({{< ref "author-templates.md#copy-a-template" >}}) API operation. | ||
|
|
||
| ## See also | ||
|
|
||
| - [Submit templates]({{< ref "submit-templates.md" >}}) | ||
| - [Author templates]({{< ref "author-templates.md" >}}) | ||
| - [View template details]({{< ref "template-detail-view.md" >}}) | ||
| - [View template submissions]({{< ref "template-submissions-view.md" >}}) | ||
| - [Import templates]({{< ref "import-templates.md" >}}) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.