Skip to content

meshery-extensions/kubectl-meshsync-snapshot

Meshery Logo

If you like Meshery, please β˜… this repository to show your support! 🀩

MESHERY IS A CLOUD NATIVE COMPUTING FOUNDATION PROJECT


Meshery - the Cloud Native Manager A self-service engineering platform, Meshery, is the open source, cloud native manager that enables the design and management of all Kubernetes-based infrastructure and applications (multi-cloud). Among other features, As an extensible platform, Meshery offers visual and collaborative GitOps, freeing you from the chains of YAML while managing Kubernetes multi-cluster deployments.

Try Meshery in the Cloud Native Playground (teaser video)

kubectl meshsync snapshot

Description:

kubectl meshsync-snapshot is a Krew plugin for capturing an ad hoc snapshot of resource information from a Kubernetes cluster. The collected data is output as a YAML file and can be uploaded to a Meshery server for visualisation.

The plugin is based on the MeshSync β€” software that provides the Meshery server with detailed information about cluster resources.

Note:

To install this plugin, you must first have Krew (the plugin manager for kubectl) installed. Follow the installation guide here.

User Guide

  1. Ensure that both kubectl and [krew]((https://krew.sigs.k8s.io/docs/user-guide/setup/install/) are installed in your system.
  2. Install the meshsync snapshot krew plugin.
kubectl krew install meshsync https://github.com/meshery-extensions/kubectl-meshsync-snapshot
  1. Follow any of these example usages

Sync all resources of any type for a single namespace

kubectl meshsync-snapshot ....

Sync resources of a single type for all namespaces

kubectl meshsync-snapshot ....

Example 3

kubectl meshsync-snapshot ....

Example 4

kubectl meshsync-snapshot ....

Contributor Guide

  1. Fork and clone this repo
git clone https://github.com/meshery-extensions/kubectl-meshsync-snapshot
  1. Build project
make build
  1. Update sha256
  1. Open meshsync-snapshot-local.yaml.
  2. Using the hash produced in step 1, replace the <put your hash here> with hash generated by make build.
  1. Install development build
make install-local

Testing a Release

  1. Install a released version of this extension
make install

About Meshery Extensions

Meshery Extensions are plugins or add-ons that enhance the functionality of the Meshery platform beyond its core capabilities. Meshery supports different types of extensions (docs):

  • Adapters: Adapters allow Meshery to interface with the different cloud native infrastructure.
  • Load Generators: for performance characterization and benchmarking
  • Integrations: model-based support for a broad variety of design and orchestration of cloud and cloud native platforms, tools, and technologies.
  • Providers: for connecting to different cloud providers and infrastructure platforms
  • UI Plugins: Meshery UI has a number of extension points that allow users to customize their experience with third-party plugins.

A self-service engineering platform, Meshery, is the open source, cloud native manager that enables the design and management of all Kubernetes-based infrastructure and applications (multi-cloud). Among other features, As an extensible platform, Meshery offers visual and collaborative GitOps, freeing you from the chains of YAML while managing Kubernetes multi-cluster deployments.


Try Meshery in the Cloud Native Playground (teaser video)


 

 

Join the Meshery community!

Our projects are community-built and welcome collaboration. πŸ‘ Be sure to see the Contributor Welcome Guide and Community Handbook for a tour of resources available to you and the Repository Overview for a cursory description of repository by technology and programming language. Jump into community Slack or discussion forum to participate.

MeshMates

Find your MeshMate

MeshMates are experienced community members, who will help you learn your way around, discover live projects, and expand your community network. Connect with a Meshmate today!

Find out more on the community.



Meshery Cloud Native Community

βœ”οΈ Join any or all of the weekly meetings on community calendar.
βœ”οΈ Watch community meeting recordings.
βœ”οΈ Fill-in a community member form to gain access to community resources.
βœ”οΈ Discuss in the Community Forum.
βœ”οΈ Explore more in the Community Handbook.





     Not sure where to start? Grab an open issue with the help-wanted label.



 

Contributing

Please do! We're a warm and welcoming community of open source contributors. Please join. All types of contributions are welcome. Be sure to read the Contributor Guides for a tour of resources available to you and how to get started.

 

Stargazers

If you like Meshery, please β˜… star this repository to show your support! 🀩

License

This repository and site are available as open-source under the terms of the Apache 2.0 License.