meshery / homebrew-tap

Homebrew Tap for for installing Meshery command line client.

 

NOTE

This tap is not used for releasing new versions of mesheryctl anymore. Latest releases of mesheryctl are now published in the official homebrew-core tap. It can now be directly installed with:

brew install mesheryctl

meshery/homebrew-tap

Homebrew Tap for installing the Meshery command line client: mesheryctl

Usage

Installation Commands

To install mesheryctl, execute the following commands.

brew tap meshery/tap
brew install mesheryctl

You need to have brew installed on your Mac or Linux system to perform these actions.

You’re ready to run Meshery. To do so, execute the following command.

$ mesheryctl system start

Meshery server supports customizing authentication flow callback URL, which can be configured in the following way

$ MESHERY_SERVER_CALLBACK_URL=https://custom-host mesheryctl system start

mesheryctl uses your current Kubernetes context, your KUBECONFIG environment variable (~/.kube/config by default). Confirm if this Kubernetes cluster you want Meshery to interact with by running the following command: kubectl config get-contexts

If there are multiple contexts in your kubeconfig file, specify the one you want to use with the use-context subcommand: kubectl config use-context <context-to-use>.

Upgrading

To upgrade mesheryctl, execute the following command.

brew upgrade mesheryctl

Example output of a successful upgrade:

➜  ~ brew upgrade mesheryctl
==> Upgrading 1 outdated package:
layer5io/tap/mesheryctl 0.3.2 -> 0.3.4
==> Upgrading layer5io/tap/mesheryctl
==> Downloading https://github.com/layer5io/meshery/releases/download/v0.3.4/mesheryctl_0.3.4_Darwin_x86_64.zip
==> Downloading from https://github-production-release-asset-2e65be.s3.amazonaws.com/157554479/17522b00-2af0-11ea-8aef-cbfe8
######################################################################## 100.0%
🍺  /usr/local/Cellar/mesheryctl/0.3.4: 5 files, 10.2MB, built in 4 seconds
Removing: /usr/local/Cellar/mesheryctl/0.3.2... (5 files, 10.2MB)
Removing: /Users/lee/Library/Caches/Homebrew/mesheryctl--0.3.2.zip... (3.9MB)
==> Checking for dependents of upgraded formulae...
==> No dependents found!

See Meshery documentation for additional usage.

Join the service mesh community!

Our projects are community-built and welcome collaboration. 👍 Be sure to see the Layer5 Community Welcome Guide for a tour of resources available to you and jump into our Slack!

Find your MeshMate

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

Find out more on the Layer5 community.

 

✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing a community Member Form.
✔️ Discuss in the Community Forum.

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

homebrew-tap's Issues

Document `mesheryctl` CLI upgrade procedure for users

Users need instructions on how to upgrade their local mesheryctl client to the latest release of mesheryctl.

[CI] add label commenter workflow

Description:

This repository should have the label commenter workflow.
It would run whenever an issue/pr is labeled with one of the targeted labels and comment down any relevant information.

Contributor Reference:

The workflow would use: https://github.com/peaceiris/actions-label-commenter

A sample workflow is defined in: https://github.com/meshery/meshery/blob/master/.github/workflows/label-commenter.yml.

It would also need a sample configuration which is defined in: https://github.com/meshery/meshery/blob/master/.github/label-commenter-config.yml

NOTE:

• In the above configuration https://github.com/meshery/meshery/blob/88d1c7c559259775ce2affab2a15a32c673c3f52/.github/label-commenter-config.yml#L26-L41 are specific to Meshery and won't be needed on every repository.
• Do comment in PR if you find any label is missing for the repo.

[Chore]Missing issues template

The issue templates do exist but are'nt inside the ISSUE_TEMPLATES folder in .github , as a result they are unrecognizable by github

[CI] Update Slack.yml and add newcomer-alert workflow

Current Behavior
Currently the slack.yml is outdated. Also there is no automated way of notifying the slack channel when a "good first issue" has been created.

Desired Behavior
Update slack.yml and add newcomer-alert.yml to the Github workflow.

---

Resources
Add the updated slack.yml file and the newcomer-alert.yml file to the .github/workflow folder.

Files needed:
https://github.com/meshery/meshery-istio/blob/master/.github/workflows/slack.yml
https://github.com/layer5io/layer5/blob/master/.github/workflows/newcomers-alert.yml

Investigate the creation of a homebrew core formula

Goreleaser is the package used to generate the mesheryctl homebrew tap. It has the following caveat (as seen on https://goreleaser.com/customization/homebrew/):

Is there a workaround or alternative approach that we might take to removing the need for users to first add the layer5io/tap to their brew repo list?

Update readme to reflect that this tap is deprecated

We've recently migrated mesheryctl releases from our custom meshery/tap to the official homebrew/core. This repositories should be updated to reflect that this tap is deprecated and users should directly install mesheryctl using brew install mesheryctl.

Add GitHub Issue Templates to this repo

A quick chore.

These may be copied from the layer5io/meshery repo.

Investigate shortening of installation commands

Can we reduce the number of commands that users who are installing mesheryctl have to run? Can the installation instructions change from having users execute two commands to one command? It would be good to investigate whether the current installation commands:

brew tap layer5io/tap
brew install mesheryctl

can be shortened to:

brew install layer5io/mesheryctl

[README] Need to fix Slack badge

Description

README.md is the first file one should read when starting a new project. For attractive look, we added some badges also.
But, there's a Slack badge failing, need to fix that.

Example Screenshot

Current Behavior

Desired Behavior

Environment:

• OS: any [e.g. Ubuntu]
• Browser: any [e.g. Chrome, Safari]
• Version: any [e.g. 22]
• Device: any [e.g. laptop, iPhone 8]

mesheryctl available as a bottle?

It would be nice to track the number of downloads (installations?) of mesheryctl. Does use of https://bintray.com/homebrew/bottles make this possible?

[README] Fix broken documentation link

The link to Meshery documentation at the bottom of the screen is broken.

The correct link is here.

Replace the Logo of Layer5 with Meshery in config.yml workflow

Description

Currently, we are using the Logo of Layer5 instead of Meshery. This repository is under the organization Meshery, so, there should be an image of Meshery.

How to resolve this

• Go to .github and replace this welcome image with the new one:

• Make sure to display the images conditionally, based on the theme selected by user.
  Here's the sample code:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/w.png">
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/b.png">
  <img alt="Meshery Logo" src="">
</picture>

New images are:

• Download these images, and upload with an appropriate name. Make sure to use conditional rendering as described above.

• After uploading the image, and removing the previous image, go to .github/config.yml folder and update the reference to previous image to the new image in the following part:

firstPRMergeComment: >
  Thanks for your contribution to the Layer5 and Meshery community! :tada:
   
  ![Congrats!](https://raw.githubusercontent.com/meshery/meshery.io/master/.github/welcome/Layer5-celebration.png)
    	   	    	    	 :star: Please leave a [star on the project](../stargazers). :smile:

Here, replace ![Congrats!](https://raw.githubusercontent.com/meshery/meshery.io/master/.github/welcome/Layer5-celebration.png) with the code

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/w.png">
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/GiorgosXou/Random-stuff/main/Programming/StackOverflow/Answers/70200610_11465149/b.png">
  <img alt="Shows a black logo in light color mode and a white one in dark color mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>

make sure to change the image sources with the path to image in the folder where you upload it.

• That's it.

Update readme with standard Meshery Readme content

Add Release Drafter for the repository

Current Situation

Each of the layer5 repositories needs releaseDrafter automation as had been done in the meshery project which takes care of drafting release notes.

Desired Situation

Add ReleaseDrafter configuration yaml file & GitHub Action.

---

Additional context

ReleaseDrafter Configuration File
ReleaseDrafter GitHub Action

Issue with pinning mesheryctl to a specific version

Current behaviour
We tried to pin mesheryctl to a specific version by running:

brew install [email protected]

as well as tried without the v

brew install [email protected]

We got similar response:

==> Searching for a previously deleted formula (in the last month)...
Warning: homebrew/core is shallow clone. To get complete history run:
  git -C "$(brew --repo homebrew/core)" fetch --unshallow

Error: No previously deleted formula found.
==> Searching for similarly named formulae...
Error: No similarly named formulae found.
==> Searching taps...
==> Searching taps on GitHub...
Error: No formulae found in taps.

Expected Behavior
We should be able to install a specific version of mesheryctl. This way rolling back to a specific version will be made possible as well.

Warning: Calling bottle :unneeded is deprecated! There is no replacement.

Just got a warning while brew install kubescape

arning: Calling bottle :unneeded is deprecated! There is no replacement.
Please report this issue to the layer5io/tap tap (not Homebrew/brew or Homebrew/core):
  /usr/local/Homebrew/Library/Taps/layer5io/homebrew-tap/Formula/mesheryctl.rb:9

Add appropriate project badges to this repo's README

Each of the Meshery repos include a set of project badges.

Please add the applicable set of badges to this repo's readme.

Example badges from main meshery repo:

Setting up builds for Darwin arm64 (Apple Silicon M1)

Here's the output for brew tap layer5io/tap

OS: Darwin arm64 20.3.0
Homebrew version: v3.0.5 (for arm64)

I know this is dependent on the development of GitHub Actions for the new architecture, but this shall keep track of it for once it is feasible.