Enhancement Description
In order to facilitate coding best practices, this adapter's code should have static analysis and error checking run as part of its build process.

Chore Description
Using the meshery-istio adapter's Actions workflow as an example, enable Static and Error checks in this repository's CI.yml workflow.

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be configured with Autopilot running to allow for automatic, operator-friendly management of Consul servers.

Desired Behavior
The Meshery adapter for Consul should support the configuration of running Autopilot to [cleanup dead servers, monitor the state of the Raft cluster, and stable server introduction].(https://learn.hashicorp.com/consul/day-2-operations/autopilot).

Dependabot can't resolve your Go dependency files.

As a result, Dependabot couldn't update your dependencies.

The error Dependabot encountered was:

If you think the above is an error on Dependabot's side please don't hesitate to get in touch - we'll do whatever we can to fix it.

View the update logs.

Current Behavior
Adapter operations are retrieved from Meshery Server using the meshops proto.

Desired Behavior

• Implementation of trait definition and workload definitions
• Registration of OAM traits with Meshery Server.

Resources
See the Meshery and Service Mesh Patterns design spec and the Meshery Architecture deck.

Current Behavior

This repository does not have a Pull request template just like our other repositories have. You can have a look at the Layer5 repo to know what a PR template looks like.

Desired Behavior

Navigate to the .github folder and create a new file PULL_REQUEST_TEMPLATE.md, copy the contents of the PR template here and paste in the new file.

Contributor Resources

• Contributing Workflow
• Contributing Overview

Enhancement Description
Each service mesh generally has one or more associated sample applications that can be used to demonstrate the power of the given service mesh. Consul uses https://github.com/hashicorp/consul-k8s-l7-obs-guide as a sample application.

Desired Behavior
The Consul adapter currently supports deploying sample applications from other service meshes. It should support the canonical Consul sample app, so that users can get the most thorough tour of Consul's features.

Enhancement Description
The Consul deployment process uses Kubernetes manifests currently.

Related Challenges
Helm is a more robust way of deploying Consul and will offer easier ways to allow the user to configure their Consul deployment. Not all, but some other Meshery adapters benefit from use of helm deployments (shared code here may be useful).

Resources

• https://learn.hashicorp.com/consul/kubernetes/kubernetes-deployment-guide

Current Behavior

Pushing to a branch whose name contain slashes '/' does not trigger the ci workflow, 'Meshery Consul'. Our naming convention for branches includes '/', e.g. feature/jdoe/24.

Desired Behavior

It is desired that the ci workflow 'Meshery Consul' is triggered when pushing changes to all branches. This ensures that checks are performed and issues caught before a PR is created.

Implementation

In ci.yaml, change the on.pushes.branches filter from '*' to '**'

Current Behavior

Right now, some of the checks in ci.yaml are commented out.
Also, the Makefile doesn't have any target for running checks.
Otherwise, same as mentioned in meshery/meshery#1050

Desired Behavior

Replace the current linter & error checker with golang-ci-lint.
Add one or several targets in Makefile to run checks.

Follow best practice from meshery/meshery#1050

Resources

https://github.com/golangci/golangci-lint

Alternatives / Additional Context

Current Behavior
A welcome bot has been configured to usher in contributors new to this project. Configuration of this welcome bot is missing from the meshery-consul repository, however.

Desired Behavior
The config.yml and the welcome folder along with the image inside of it should be copied and placed into the .github folder in this repository.

Current Behavior

Currently, there are no automatic tests that help make refactoring safe(r). Testing has to be performed manually.

Desired Behavior

A basic set of simple end-to-end tests that check basic functionality. Initially, the tests are intended to be used only locally, i.e. not as part of the CI pipeline. At first, the tests will not be fully automated, i.e. require some manual setup, e.g. setting up a local cluster.

Resources

• https://github.com/bats-core/bats-core - Bats is a TAP-compliant testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected.
• https://github.com/fullstorydev/grpcurl - grpcurl is a command-line tool that lets you interact with gRPC servers. It's basically curl for gRPC servers.

Alternatives / Additional Context

The basic pattern of these tests is to install the mesh in the cluster, wait until all rollouts are ready, install sample applications, wait until all rollouts are ready, possibly test the sample application, delete the sample application, repeat for all sample applications, and finally delete the mesh.

Description

• Bump github.com/layer5io/meshery-adapter-library from 0.1.3 to 0.1.7
• Bump github.com/layer5io/meshkit from 0.1.18 to 0.1.28

Description
The issue templates are stale and need refreshed with a newer copy from the meshery repo.

Implementation

1. Copy the issues templates from the .github/ISSUE_TEMPLATE folder in the meshery repo to the ISSUE_TEMPLATE folder in this repository.

Create two issue templates in the meshery-consul repo by copying the meshery repo's issue templates.

Current Behavior
See meshery/meshery#1270 for additional details and the meshery/meshery#284 epic.

Desired Behavior
Implement in the same fashion that has been done in layer5io/meshery repo.

Issue: A Consul deployment on a cluster with less than three nodes finds "consul-server" pods stuck in a Pending state.

Example of a two node system:

➜  ~ k get pods -n consul
NAME                                                              READY   STATUS    RESTARTS   AGE
consul-consul-6jkw6                                               0/1     Running   0          24m
consul-consul-connect-injector-webhook-deployment-5579b766zpmwm   1/1     Running   0          24m
consul-consul-server-0                                            0/1     Pending   0          24m
consul-consul-server-1                                            0/1     Pending   0          24m
consul-consul-server-2                                            0/1     Pending   0          24m
consul-consul-test-1klet                                          0/1     Error     0          24m

The consul servers fail to start:

 Type     Reason            Age                 From               Message
 ----     ------            ----                ----               -------
 Warning  FailedScheduling  47s (x21 over 26m)  default-scheduler  pod has unbound immediate PersistentVolumeClaims

Request: Provide flag to nullify "consul-server"s Pod anti-affinity requirement at https://github.com/layer5io/meshery-consul/blob/master/consul/config_templates/consul.yaml#L615.

@nicholasjackson @eveld, regarding this issue, it seems we’ll need to null the podAntiAffinity requirement in the consul pod spec to allow deployments onto lesser than 3 node clusters. Is that right? https://www.consul.io/docs/platform/k8s/helm.html#v-server-affinity Are there any other solutions we should consider for small deployments?

Currently Behavior
A copy of Meshery-consul is "released" with every merge to master branch.

Desired Behavior
Update ci.yml to only push docker images in the presence of a release tag. Tag docker images akin to the method used for learn-layer5 with a slight tweak: prefix each release tag with the word "stable".

Example
Image 1

• layer5/meshery-consul:stable-latest
• layer5/meshery-consul:stable-v0.4.1
• layer5/meshery-consul:stable-324vdgb (sha)

Image 2

• layer5/meshery-consul:stable-v0.4.0
• layer5/meshery-consul:stable-289d02 (sha)

See this section Meshery Build & Release Strategy: https://docs.google.com/document/d/11nAxYtz2SUusCYZ0JeNRrOLIxkgmmbUVWz63MBZV2oE/edit#heading=h.25ywhtn8rxkj

Dependabot can't resolve your Go dependency files.

As a result, Dependabot couldn't update your dependencies.

The error Dependabot encountered was:

If you think the above is an error on Dependabot's side please don't hesitate to get in touch - we'll do whatever we can to fix it.

View the update logs.

Issue Description
Create contributing.md that points to the central contributing.md in the Meshery repo.

Create a stub CONTRIBUTING.md in each of the repos that essentially say:
“You want to contribute to the project? Yay! We want you to! Visit our centralized instructions for contributing.", where the “contributing” is a hyperlink to the CONTRIBUTING.md in the main meshery repo.

Future Effort
In time, as more contributors join the project, we may need a meshery-community repo that has all this and much more info or to have a community / contributing section in the meshery docs.

Description
The Layer5 community's GitHub issue template for documentation is missing in this repo.

Expected Behavior
The meshery-consul repo should contain the documentation issue template in the ISSUE_TEMPLATE folder.

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be configured to allow the injector to automatically inject the Connect sidecar into all pods.

Desired Behavior
The Meshery adapter for Consul should support the deployment configuration sidecar injection for authentication with Kubernetes service

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be configured to enforce TLS between agents.

Desired Behavior
The Meshery adapter for Consul should support the post-deployment configuration of making agents to communicate with TLS.

Current Behavior

This adapter is not using the meshery-adapter-library.

Desired Behavior

This adapter is using the meshery-adapter-library.

Resources

• https://github.com/layer5io/meshery-adapter-library

Additional Context

The initial version of meshery-adapter-library has been developed by using code from the kuma adapter and this adapter. The code for this adapter has been refactored to use meshery-adapter-library, for verification and testing purposes. This is the issue related to that work.

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be configured to secure service-to-service communication with authorization and encryption.

Desired Behavior
The Meshery adapter for Consul should support the automatic establishment of TLS connections for inbound and outbound connections without applications being aware of Connect at all.

Description

Current version is 1.13, update to 1.15.

Test to see how it turns out, what else needs to be updated.

Then, update meshery/meshery#1991

The module path github.com/layer5io/gokit found in your go.mod doesn't match the actual path github.com/layer5io/meshkit found in the dependency's go.mod.

Updating the module path in your go.mod to github.com/layer5io/meshkit should resolve this issue.

View the update logs.

Enhancement Description

Verify the SMI-compatibility of Consul against the standard suite of compliance tests.

Current Situation

Applying http-bin.yaml to the cluster gives the following error:

error: unable to recognize "httpbin-consul.yaml": no matches for kind "Deployment" in version "extensions/v1beta1"

Desired Situation

Applying http-bin.yaml to the cluster is successful.

Implementation

This Deployment version was deprecated and no longer works in recent versions of k8s (e.g. 1.16).
Specify apiVersion: apps/v1 and modify the template, a label selector field needed.

Description
Some of the badges in this repos readme are missing informative hyperlinks.

Desired Behavior
The badges (and their links) that are used in the Meshery repo's README are a great example of how the badges in this repo can be improved.

Description
The current build has failing error checks and failing static checks.

Expected Behavior
All build checks should be passing.

Describe the issue
Consul adapter was created right before KubeCon EU 2019. After that we have not updated the adapter to use the latest updates in Consul.

The file which will need update is https://github.com/layer5io/meshery-consul/blob/master/consul/config_templates/consul.yaml

Current State:
The meshery-consul docs are missing a description of many of the capabilities of the adapter.

Desired State:
The docs should be well-written and robust.

Contributor Resources

• Meshery documentation site
• Meshery documentation source
• Instructions for contributing to documentation

Description
Right now, CI-Status badge shows actions as failing but that job is deprecated & we have renamed our ci action.

Expected Behavior
Change the current badge with this badge:

![Meshery Consul](https://github.com/layer5io/meshery-consul/workflows/Meshery%20Consul/badge.svg)

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be performed using the “GA” and the “beta” versions of Consul and different versions of those channels.

Desired Behavior
The Meshery adapter for Consul should support the option of allowing users to choose what release channel and what release version they would like to deploy.

Enhancement Description
SMP is a standard way of measuring service mesh performance. Incorporate Meshery into Consul release process as universal performance measure.

Desired Behavior

• Test configurations defined by HashiCorp.
• Test results published to Meshery Cloud.

Current Behavior

Current version used is v0.1.0-beta

Desired Behavior

Use latest version, v0.1.0.

Current Behavior

The current name is ""Latest version of Consul with sidecar injector"

Desired Behavior

It would be useful to have a name that describes the configuration, in this case that it is an unsecured configuration for one node.
Also, "Latest version" might be removed, because it quickly isn't.
Suggestions

• "Consul Connect (unsecured, 1 server)"
• "Consul Connect - unsecured / not production-ready - suitable for one node"?

Implementation

Change in https://github.com/layer5io/meshery-consul/blob/master/consul/supported_ops.go

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be configured in any number of ways. There are best practices of deploying Consul that a deployment should be checked against.

Desired Behavior
The Meshery adapter for Consul should provide support for validating the current Consul deployment against best practices.

Current Behavior

Currently, BATS tests can only be run locally, they're not executed as part of the CI-workflow.

Desired Behavior

BATS integration tests should be executed as part of GitHub CI-workflow.

Resources

• Creating cluster using KinD: https://github.com/layer5io/meshery-linkerd/blob/master/.github/workflows/ci.yml
• There exists a github action that could be used: https://github.com/marketplace/actions/setup-bats-testing-framework
• BATS version used in consul is https://github.com/bats-core/bats-core (https://github.com/sstephenson/bats isn't maintained anymore)

Alternatives / Additional Context

• The tests are run directly against the adapter.
• Locally, the tests can be run by make e2e-tests-localhost if the adapter is reachable on localhost
• If not, the the env variable MESHERY_ADAPTER_ADDR can be set, and make e2e-tests used to run the tests.

Description:
The Meshery adapter for Consul is failing lint checks when building. Currently, these checks are not passing:

Found 5 lint suggestions; failing.
129
##[error]/home/runner/work/meshery-consul/meshery-consul/consul/client.go:23:2: a blank import should be only in a main or test package, or have a comment justifying it
130
##[error]/home/runner/work/meshery-consul/meshery-consul/consul/client.go:29:6: type name will be used as consul.ConsulClient by other packages, and that stutters; consider calling this Client
131
##[error]/home/runner/work/meshery-consul/meshery-consul/consul/consul.go:39:1: exported method ConsulClient.CreateMeshInstance should have comment or be unexported
132
##[error]/home/runner/work/meshery-consul/meshery-consul/consul/consul.go:309:1: comment on exported method ConsulClient.ApplyOperation should be of the form "ApplyOperation ..."
133
##[error]/home/runner/work/meshery-consul/meshery-consul/consul/yaml.go:65:1: exported method YAMLDecoder.Close should have comment or be unexported
134
##[error]Process completed with exit code 123.

Expected Behavior
All lint checks should pass.

See an example of these failures here - https://github.com/layer5io/meshery-consul/pull/7/checks?check_run_id=218292837

Current Situation
The ReleaseDrafter utility (GitHub Action) is not configured in this repository.

Desired Situation

• Releasedrafter should be configured to execute whenever a PR is merged to master in this repo.

Implementation

• Copy the releasedrafter config and the releasedrafter workflow file from the meshery repo and place in the .github folder here.

Current Situation

Applying http-bin.yaml to the cluster gives the following error:

error: unable to recognize "bookinfo.yaml": no matches for kind "Deployment" in version "extensions/v1beta1"

Desired Situation

Applying bookinfo.yaml to the cluster is successful.

Implementation:

This Deployment version was deprecated and no longer works in recent versions of k8s (e.g. 1.16).
Specify apiVersion: apps/v1 and modify the template, a label selector field needed.

Description

• Bump github.com/layer5io/meshkit from 0.1.17 to 0.1.18
• Bump github.com/layer5io/meshery-adapter-library from 0.1.0 to 0.1.3

Current State:
The Meshery logo used in the README is outdated.

Desired State:
Use the new logo as seen in https://github.com/layer5io/meshery-istio's README.

Enhancement Description
Meshery adapters facilitate service mesh configuration. Consul deployments may be configured with intentions to define which services are allowed communicate with which other services.

Desired Behavior
The Meshery adapter for Consul should support the configuration of intentions to define which services are allowed communicate with which other service.

Enhancement Description
A new sample app is available as a workload on Consul. The name of this app is Image Hub - https://github.com/layer5io/image-hub. This app should be available through the Consul adapter.

Current Situation
A welcome bot has been configured to usher in contributors new to this project. Configuration of this welcome bot is missing from the meshery-consul repository, however.

Desired Situation
The config.yml and the welcome folder along with the [image](

) inside of it should be copied and placed into the .github folder in this repository.