maistra / istio-workspace Goto Github PK

Currently, we directly delegate to Telepresence CLI to start local development flows. Providing strategies such as --swap-deployment. This requires every user to have certain privileges, which might be problematic in day-to-day usage in the teams.

To mitigate this challenge we could move this responsibility to a dedicated controller run in the cluster which will take care of setting up pods properly to have telepresence images running.

Resulting in

T: Starting network proxy to cluster using the existing proxy Deployment details-v1-test

T: Failed to find deployment details-v1-test:
T: No resources found.
T: Error from server (NotFound): deployments.extensions "details-v1-test" not found

T: Exit cleanup in progress

See https://github.com/aslakknutsen/istio-workspace/pull/99#discussion_r276119831

Set up docs generation pipeline. Contribution/dev guide can be a good skeleton to start with

Paths to consider:

• plain old asciidoc (arquillian way with docker image generating github pages)
• antora based docs

Potentially integrating it with Netlify.

in case of executing ike as interactive / user-driven shell tool we might want to have logging in the plain text enabled, as that's easier to read for a human.

When we execute operator-related bits on the server, however, we should produce structured logging.

This issue is intended to gather potential solutions, as we definitely need a better way to handle this.

Currently, e2e rely on --offline to avoid Session creation

Should be updated to do:

make deploy-operator
make deploy-sample-bookinfo (missing. services, gateway, virtualservices, destinationrules)
ike develop --deployment details-v1?

• Basic model impl
• Support in e2e

• templates for bugs and PRs
• review and streamline labels
• manage labels as code / github app
• conventions and bots to keep them under a leash

Introduce a step in CircleCI build which

• invokes make format
• pushes changes back to the PR (if editing allowed)

Look at the operator test framework

• Separate object conversion logic out of session.go
• Separate between Object conversion/sync and server update

If .gitignore is found in the folder ike is watching we should exclude the same paths from watch.

https://github.com/goreleaser/goreleaser

• Accumulate the state based on the Ref state
• Document the possible options

When changes are made on the files in the specified locations we should rebuild the project if defined how and re-run telepresence session.

This should be enabled if ike develop has --watch flag provided (or is set in the cfg file). This should be a list of directory patterns to observe and re-run the build and telepresence process when a change occured.

By default both build and run steps are executed when calling ike develop, unless --run-only flag is specified.

With config file

develop:
  deployment: test
  run: "python3 server.py"
  port: 5555

and CLI call:

$ ike develop -r './test.sh'`

Telepresence should be called with --run './test.sh', but is with --run 'python3 server.py'.

The D/DC config found on the server would have some ports defined. The ike CLI would reuse this information to auto set the --port parameter.

If you have multiple ports exposed - exposed all of them - get free local ports to be mapped to D/DC.

List all the exposed ports as part of the command output.

See https://github.com/aslakknutsen/istio-workspace/pull/44#discussion_r259776827

To automate dependency updates we should add Dependabot to this repo.

That probably should be done when we move to some org.

Binary download v defined in Makefile:
https://github.com/aslakknutsen/istio-workspace/blob/master/Makefile#L44

Code dependency v defined in Gopkg:
https://github.com/aslakknutsen/istio-workspace/blob/master/Gopkg.toml#L60

Unify?

Docs for e.g. --run

As a first cut, following command:

$ ike serve --deployment name --port 8000 --run 'python3 server.py'` 

should result in invoking telepresence as part of it

telepresence --swap-deployment name --expose 8000 --method inject-tcp --run python3 server.py;'

Instead of relying on CLI flags we should give the user the ability to specify common / infrequently changed configuration items through other means, such as environment variable (prefixed with IKE_) and yaml file.

So instead of e.g. invoking ike develop --deployment NAME --method inject-tcp developer can set IKE_DEVELOP_DEPLOYMENT=NAME and have config file (.ike.config sitting in the folder from which the command is invoked) with content:

develop:
  method: inject-tcp

instead.

Following order of precedence should be preserved when calling a command (where each item takes precedence over the item below, e.g. flag will always be the most important one):

• flag
• environment variable
• config file entry
• default (if specified)

https://github.com/operator-framework/operator-lifecycle-manager

Avoid manipulating flags deep down in code.

• --header "end-user:jason"
• ?

• document api
• document user guide

If no DestinationRule found with matching name, one should be created.

It turned out we have to make quite a bit of cluster mgmt commands before we are able to execute e2e tests on circleci. At this point what was supposed to be simple setup/teardown part of e2e-tests in ginkgo code turned out to grow a bit too much.

We should move most of the cluster setup into make file instead, so that we can conveniently use it both for CI and while working locally with the code.

If no VirtualService found with matching name, one should be created.

Support creating a Session when using Openshift style Kinds, e.g. DeploymentConfig

Replace https://github.com/aslakknutsen/istio-workspace/blob/c6e328d39196698bb67fcd25a831a82d52f80ab1/pkg/istio/cli_helper.go with go client.

Currently used

• oc apply to create session
• oc get session
• oc delete session

Find the minimal auth level required to run the client side

• Create a "Developer-User"
• Create a Role / RoleBinding for the minimal required auth level required
• Run the cli e2e test using this auth level

While running CLI check if there's newer version released and suggest user the update path

Create CLI tool enabling developing on prod

• overview / vision
• use cases
• user guide
• development guide

Currently, we rely on default namespace being defined in kube context. This, however, limits our testing possibilities, as we might want to use ike for two different namespaces at the same time.

Since telepresence allows to specify --namespace as an argument we should add corresponding flag and delegate.

https://github.com/operator-framework/operator-lifecycle-manager/blob/00eab85df0fd570891754cc743bc3d5831e9dd62/doc/design/building-your-csv.md

see https://github.com/aslakknutsen/istio-workspace/pull/34#discussion_r258048595

• executes current handler code when ike is invoked
• shows help with all available commands
• prints version (project + build metadata, golang runtime, operator sdk version)

Ignore common project files which should not be watched:

• scm folders
• IDE files
• logs

Currently, hardcoded to "v1-test".

Possibly rely on session name as a suffix to the target v.

Affects mutateDestinationRule and mutateVirtualService

• Change package name
• Move repo
• Update circleci job

Kube client is hardcoded to read  /var/run/secrets/kubernetes.io/serviceaccount which can't be found under TP as everything is mounted under $TELEPRECENSE_ROOT.

Possible fixes:

• Fix Kube client
• chroot tp?

Workaround:

Rely on ENV KUBERNETES_CONFIG and point to a Kube Config file pointing to the cluster/user/context. Requires sharing prod tokens on the local machine.

https://github.com/kubernetes/client-go/blob/6134db91200ea474868bc6775e62cc294a74c6c6/rest/config.go#L401

Currently we only support directory paths to watch for changes. In addition, we should let users define glob patterns, so they can limit files to react on.

• if only relative patterns (e.g. src/main/**/*.java) are defined, the watch is applied on the current directory
• if an absolute paths are defined the relative patterns should be applied on those instead

• Teleprecence
• Pure deployment
• Squash?

spec:
  refs:
    - name: x-deploy
      strategy: telepresence
      args:
        version: 100.2
    - name: y-deploy
      strategy: image
      args:
        image: x/org:latest