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 FAQ on connecting your own Kubernetes cluster to Meshery Playground #209

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions site/src/assets/data/faq/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,36 @@ So, in short, you can share access to your Kubernetes cluster with other users,
link: "https://meshery.io",
linktext: "Get Started with Meshery",
},
{
question:
"How do I connect my Kubernetes cluster to the Meshery Playground?",
category: "Meshery Playground",
answer: `
To connect your Kubernetes cluster to the Meshery Playground, follow these steps:
1. **Generate a Kubeconfig File**: Run the following command to generate a kubeconfig file for your cluster, including the necessary context information for connecting to your publicly accessible Kubernetes API:
\`\`\`bash
kubectl config view --minify --flatten > config_minikube.yaml
Copy link
Member

Choose a reason for hiding this comment

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

Why are we naming the file "minikube"?

Copy link
Author

Choose a reason for hiding this comment

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

Why are we naming the file "minikube"?

Yes, I can change it to a more general name. I will add that the file can be named, for example, 'config.yaml,' to reflect the specific cluster context.

Copy link
Author

Choose a reason for hiding this comment

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

Why are we naming the file "minikube"?

Yes, I can change it to a more general name. I will add that the file can be named, for example, 'config.yaml,' to reflect the specific cluster context.

It will work right?

\`\`\`
2. **Ensure Network Accessibility:**
- Your Kubernetes API server must be publicly accessible or reachable over the network. This usually involves configuring the API server with a public endpoint and ensuring it’s accessible from external networks.
- Adjust your firewall settings, security groups, or VPN configurations to allow traffic from the Meshery Playground environment to your API server (typically on port 6443).

3. **Upload kubeconfig:**
- Use the Meshery Playground Web UI to upload your kubeconfig file, which contains the necessary context and credentials for Meshery to authenticate and connect to your Kubernetes cluster.

4. **Verify TLS/SSL Certificates:**
- Ensure that your kubeconfig includes the correct TLS/SSL certificates, so Meshery can securely connect to your API server.

5. **DNS and IP Configuration:**
- If your Kubernetes API server is exposed via a domain name, make sure that this domain is resolvable and that Meshery Playground can reach it.

6. **Authentication and Permissions:**
- The kubeconfig should contain valid credentials (such as tokens or certificates) to authenticate Meshery Playground with your Kubernetes API. Ensure that these credentials have the necessary permissions to interact with the cluster.

`,
link: "https://docs.meshery.io/installation/kubernetes",
linktext: "Meshery documentation",
},
],
};

Expand Down
Loading