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

Add kerberos factory to deployment guide #4

Merged
merged 13 commits into from
Oct 18, 2024
Merged

Conversation

cedricve
Copy link
Member

@cedricve cedricve commented Oct 18, 2024

Pull Request Description: Add Kerberos Factory to Deployment Guide

Motivation

The current deployment guide lacks a streamlined method for non-technical users to manage Kerberos Agents, which can be cumbersome and error-prone. Adding Kerberos Factory provides a user-friendly interface for managing Kerberos Agents, making the process more accessible and efficient.

Changes Made

  1. README.k8s.md and README.microk8s.md:

    • Updated instructions to include Kerberos Factory for easier agent management.
    • Clarified the use of mongodb-configmap.yaml for MongoDB configurations.
    • Added steps to create the kerberos-factory namespace and deploy Kerberos Factory.
    • Included instructions to apply necessary cluster roles for Kerberos Factory.
  2. New Configuration Files:

    • kerberos-factory-clusterrole.yaml: Defines the cluster role and binding required for Kerberos Factory to interact with Kubernetes resources.
    • kerberos-factory-deployment.yaml: Deployment configuration for Kerberos Factory.
    • kerberos-factory-service.yaml: Service configuration for Kerberos Factory, using a NodePort for external access.
  3. Existing Configuration Updates:

    • data-filtering-deployment.yaml and kerberos-agent-deployment.yaml: Adjusted STORAGE_URI and AGENT_KERBEROSVAULT_URI to use vault-nodeport instead of vault-lb for consistency.
    • mongodb-configmap.yaml: Added a new entry for MONGODB_DATABASE_FACTORY to facilitate Kerberos Factory's MongoDB connection.

Why it Improves the Project

  • User-Friendly: Provides a GUI for managing Kerberos Agents, reducing the complexity for non-technical users.
  • Efficiency: Streamlines the deployment and management process of Kerberos Agents.
  • Consistency: Ensures that all components are using consistent configurations and best practices.
  • Scalability: Facilitates easier scaling and management of Kerberos Agents through a centralized interface.

By integrating Kerberos Factory, we enhance the overall usability and maintainability of the project, making it more accessible to a broader audience.

@cedricve cedricve merged commit a4423b8 into main Oct 18, 2024
2 checks passed
@cedricve cedricve deleted the add-kerberos-factory branch October 18, 2024 13:44
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.

1 participant