add administrators doc for configre porter agent #150
Merged
Conversation
This file contains 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
Signed-off-by: Yingrong Zhao <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #150 +/- ##
=======================================
Coverage 76.75% 76.75%
=======================================
Files 13 13
Lines 1540 1540
=======================================
Hits 1182 1182
Misses 227 227
Partials 131 131
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
carolynvs
requested changes
Feb 6, 2023
| description: How to customize Porter Agent | ||
| --- | ||
|
|
||
| The Porter Agent is a critical component in executing Porter commands in a controlled and reliable manner. With the AgentConfig Custom Resource Definition (CRD), you can customize the Porter Agent to meet your specific needs and requirements. |
There was a problem hiding this comment.
Let's add a quick definition of what the agent is and does. How about
Suggested change
| The Porter Agent is a critical component in executing Porter commands in a controlled and reliable manner. With the AgentConfig Custom Resource Definition (CRD), you can customize the Porter Agent to meet your specific needs and requirements. | |
| The Porter Agent is a containerized version of the Porter CLI that is optimized for running Porter commands on a Kubernetes cluster. With the AgentConfig Custom Resource Definition (CRD), you can customize how the Porter Agent is run to meet your specific needs and requirements. For example, you can specify the version of Porter to use, install additional Porter plugins, or provide a custom Porter config file. |
| spec: | ||
| porterRepository: <your-own-repository> | ||
| porterVersion: v1.2.3 | ||
| serviceAccount: <service-account-for-porter-agent> |
There was a problem hiding this comment.
Let's include a quick mention of the RBAC roles that the operator ships with by default so that they know that they can use those to properly assign permissions to a custom service account.
|
|
||
| ## Configuring Porter Plugins | ||
|
|
||
| In addition to specifying the version of Porter, you can also specify the plugins you need to install before bundle executions. For example, if you want to use the Kubernetes and Azure plugins, you can configure the AgentConfig like this: |
There was a problem hiding this comment.
Suggested change
| In addition to specifying the version of Porter, you can also specify the plugins you need to install before bundle executions. For example, if you want to use the Kubernetes and Azure plugins, you can configure the AgentConfig like this: | |
| You can also specify any required plugins necessary for your installation of Porter. For example, if you want to use the Kubernetes and Azure plugins, you can configure the AgentConfig like this: |
| metadata: | ||
| name: customAgent | ||
| spec: | ||
| porterRepository: <your-own-repository> |
There was a problem hiding this comment.
How about we just list the relevant config for the part of the config file we are providing an example for, and remove the repo and version here?
|
|
||
| The schema for the pluginConfigFile field is defined [in the Porter reference documentation](/reference/file-formats/#plugins). | ||
|
|
||
| 🚨 WARNING: By default, the plugin version is set to `latest`. However, it is recommended to specify the plugin version to avoid any unexpected behavior that could result from an outdated plugin. |
There was a problem hiding this comment.
Suggested change
| 🚨 WARNING: By default, the plugin version is set to `latest`. However, it is recommended to specify the plugin version to avoid any unexpected behavior that could result from an outdated plugin. | |
| 🚨 WARNING: By default, the plugin version is set to `latest`. We recommend pinning to specific version of any plugins used to avoid undesired behavior caused a stale plugin cache. Porter currently does not expire cached installations of plugins, so installing "latest" will not pick up new versions of plugins when they are released. |
Signed-off-by: Yingrong Zhao <[email protected]>
carolynvs
reviewed
Feb 7, 2023
| @@ -44,21 +44,22 @@ spec: | |||
| installationServiceAccount: <service-account-for-the-installation> | |||
| ``` | |||
|
|
|||
| The porter operator ships two pre-defined ClusterRole, editor role and viewer role, for AgentConfig resources to help you to properly assign permissions to a custom service account. | |||
There was a problem hiding this comment.
Can you include the full role names here or are they not a well-defined name?
Signed-off-by: Yingrong Zhao <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This doc pages demonstrates some ways to configure porter agent for various use cases
related issue: #122