Skip to content
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

docs: Fix executor plugin example in docs #7614

Merged
merged 1 commit into from
Jan 24, 2022

Conversation

dinever
Copy link
Member

@dinever dinever commented Jan 22, 2022

Signed-off-by: Peixuan Ding [email protected]

Hi, I've been trying the executor plugin and found several issues with the docs. This PR fixes them. Please see the inline comments for more details.

Thanks!

ports:
- containerPort: 4355
sidecar:
container:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

container is defined under sidecar:

type PluginSpec struct {
Sidecar Sidecar `json:"sidecar"`
}
type Sidecar struct {
Container apiv1.Container `json:"container"`
}

cpu: "250m"
limits:
memory: "128Mi"
cpu: "500m"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

securityContext, resources are mandatory:

if c.Resources.Requests == nil {
return fmt.Errorf("resources requests are mandatory")
}
if c.Resources.Limits == nil {
return fmt.Errorf("resources limits are mandatory")
}
if c.SecurityContext == nil {
return fmt.Errorf("security context is mandatory")
}

@dinever dinever requested a review from alexec January 22, 2022 22:20
Copy link
Contributor

@alexec alexec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 LGTM!

@alexec alexec merged commit efb0041 into argoproj:master Jan 24, 2022
@dinever dinever deleted the fix-executor-plugin-docs branch January 24, 2022 18:24
yriveiro pushed a commit to yriveiro/argo-workflows that referenced this pull request Jan 27, 2022
@sarabala1979 sarabala1979 mentioned this pull request Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants