zalando/zally

nardevar23

@nardevar23

[root@localhost zally]# go build
app.go:4:2: cannot find package "github.com/urfave/cli" in any of:
/usr/lib/golang/src/github.com/urfave/cli (from $GOROOT)
/root/go/src/github.com/urfave/cli (from $GOPATH)
app.go:5:2: cannot find package "github.com/zalando/zally/cli/zally/commands" in any of:
/usr/lib/golang/src/github.com/zalando/zally/cli/zally/commands (from $GOROOT)
/root/go/src/github.com/zalando/zally/cli/zally/commands (from $GOPATH)
main.go:7:2: cannot find package "github.com/zalando/zally/cli/zally/domain" in any of:
/usr/lib/golang/src/github.com/zalando/zally/cli/zally/domain (from $GOROOT)
/root/go/src/github.com/zalando/zally/cli/zally/domain (from $GOPATH)

unable to install go CLI

Rob Oxspring

@roxspring

@nardevar23 are you seeing any "unhealthy" indicators other than that string? is the web ui functional?? is the server responding??

Rob Oxspring

@roxspring

FWIW you can definitely ignore the "unhealthy" indicator - it's badly configured and can never report healthy - zalando/zally#1133

malakIN2020

@malakIN2020

Hi All, have done the zally setup on windows machine and successfully able to run web ui on localhost:3000. As part of minor text changes on UI hav modified the bundle.js file located at \zally-webui\node_modules\zally-web-ui\src\client\public\assets, the changes are reflected fine.

The setup on AWS linux EC2 instance is also working fine however i am not able to do similar UI changes on ec2 after modifying the bundle.js file. After modifying the file i restarted both docker container and ec2 instance too but the changes are not reflected.

Please help to mitigate issue with bundle.js file, changes are not reflected on zally web ui. Is there any other file which can be modified under docker to modify the text.

Rob Oxspring

@roxspring

Modifying a file within the node_mofules directory doesn't sound a great idea, and I'm not clear why there'd be a zally-web-ui under it either... what's the text change you're attempting to make?

malakIN2020

@malakIN2020

Hi @roxspring on the UI page the text says "Check if your SWAGGER Schema conforms to Zalando's REST API Guidelines" this we want to modify as "Check below your Open API specs to conforms with REST API Guidelines" . Also the hyperlink for 'Rest API guidelines' we want to provide an internal link.

nkerschb

@nkerschb

Hello!
I got a question concerning the swagger-zalando-extension. I have https://plugins.jetbrains.com/plugin/8347-swagger and https://plugins.jetbrains.com/plugin/11115-swagger-zalando-extensions- installed in IntelliJ (2019.3.3), furthermore running zally locally which I can curl on localhost:8000/api-violations and get proper violations with a wrong openapi spec. However, when I point the zalando intellij extension to my local zally, "nothing happens", i.e. the linter doesn't work from within Intellij. Any pointers what to check? Thank you!

Rajind Ruparathna

@Rajind

Hi, I was going through the documentation and the source and couldn't find a rule for "MUST use HTTP methods correctly [148]" https://opensource.zalando.com/restful-api-guidelines/#148. Wasn't a rule implemented for that one and if so it is because it is too broad to implement from a rule?

Andreas Schlapbach

@schlpbch

Hi there

Great tool!

Question: What are best practices to adapt a ruleset?

Vadim Shaigorodskiy

@vadeg

Hi @schlpbch !
I think for the moment the best way is to fork a repo and adapt. We are working on the topic which allows to plugin new rule sets without forking a repo. @roxspring you were one of first adopters. Could you share your experience?

Rob Oxspring

@roxspring

Hi @schlpbch! Sorry for the silence - didn't spot your message last week. Maintaining a fork is definitely the easiest option at the moment. We're getting close to pluggable rulesets but we're not quite there yet.

In terms of adapting zally rules we took a few approaches, depending on requirements, which may work for you too:

Rob Oxspring

@roxspring

Submit patches to Zally to make existing rules more configurable, and run with your own config. The Zalando team are generally pretty receptive to this sort of thing, but can lead to odd situations where an "X must have Y format" rule becomes reconfigured to require "Z" format and the Zalando folks don't want to change their rule's wording.

Rob Oxspring

@roxspring

Where rules are potentially useful to the outside world then I took the approach of proposing rules to the zally ruleset, often leaving them disabled in the default configuration where the Zalando folks don't want to adopt them too, but configured in my fork.

Rob Oxspring

@roxspring

Where rules didn't really make sense to be public then I maintained some internal rules in my fork. This is a little painful when refactoring are performed upstream and need to be accounted for in the fork - but mostly the refactoring were mine so I had a head start and didn't suffer too badly :).

Rob Oxspring

@roxspring

That last approach was my default at first, but I wish I'd submitted more of them upstream from the start. There was talk of creating a third ruleset in the master branch for my in-house, and I got clearance from work but didn't get time to do it and have since moved to a different company (not even doing any REST APIs).

If the Zalando folk are up for it then I'd be very tempted to recommend this approach and create a "SBB" ruleset in the zally master codebase, with your fork just changing the config. I think it'd be good for cross pollination of ideas, but it's also potentially painful if fixes for in-house rules are gated by PR reviews from Zalando.

Andreas Schlapbach

@schlpbch

Dear all, thanks for your recommendations. Following the fork approach worked for me.

Andreas Schlapbach

@schlpbch

The only point of confusion I had was when trying to change the snake-case to camelCase rule. The rule suggests that it's handle there, actually it's in the 'reference.conf' in zally-core. I resolved it by copying the CaseChecker config to the 'reference.conf' of my ruleset, so that I didn't to change the anything in zally-core.

Thus, it might be a slight improvement to document this dependency by documenting that in the rules dealing with cases and/or to add the CaseChecker config to the zalando-ruleset directory.

If this is the way to go, I can propose a patch.

Vadim Shaigorodskiy

@vadeg

@schlpbch I agree. It is worth mentioning this. Please propose a patch.

Metalshad0w

@Metalshad0w

Hi all, i started to use Zally last week, great tool! But one Zallando rule that is not clear to me is: MUST not break backward compatibility [106]. Zally makes this validation between versions? I didn't found any reference of this rule in the code...

Tronje Krop

@tkrop

Yes, we unfortunately, have not been able to implement all the rules in Zally. We implemented only around 30 (the most important for us) of the 140 rules in the guidelines. Partially, because many are difficult to implement, partially because we lack the resources.

Hezer-Laine

@Hezer-Laine

Hi Zally team, I just cloned latest zally from master. And got compileKotlinTest failure as above screenshot.

Could you please help me figure out why de.zalando.zally.statistic.ReviewStatistics cannot be resolved?

Tronje Krop

@tkrop

Sorry, for the late reply. I did a fresh clone and tried a clean build, but I could not reproduce an error. Have you persisting problems?

Pasan Gamaetige

@psnmissaka

Hi all, I was working on migrating our Zally components to ECS. Was wondering what sort of resource allocations should we keep for each component. Couldn't find much information in the readme files. Can someone assist if you have come across the same path? Thanks!

Tronje Krop

@tkrop

Hii Pasan, can you be more specific about which components in Zally you are referring to? If you talk about the server and web-ui: we are currently running these as Docker images in Kubernetes. The server is running with 1.5GB since we are to lazy to monitor, however 756MB should be enough when I have a second look at the actual usage data. The web-ui is running with 128MB sufficiently stable since a long time.

Pasan Gamaetige

@psnmissaka

Hi Tronje, thanks for getting back soon. The Zally components were the web-ui and the server. And yeah I can confirm those are ranges when I monitor the existing setup we have. I wanted to confirm the numbers before setting out the resource allocation. Again thanks a lot!

Tronje Krop

@tkrop

You are welcome.

Kirill Baurchanu

@baurchanu

Hi, I'm trying to build master branch but getting error (can't resolve config4k:0.4.1 dependency, 'cause it isn't published to maven central, only to jcenter). Is it known issue?

Vadim Shaigorodskiy

@vadeg

Hi @baurchanu !
Not, it unknown issue. Please create an issue in Github. We will fix it asap.

Vadim Shaigorodskiy

@vadeg

@baurchanu I have just checked master branch and it works. Indeed config4k:0.4.1 is not in Maven central, but it is in jitpack.io which is also used by Zally.

I will update config4k:0.4.1 to config4k:0.4.2 anyways.

Morten Haraldsen

@ethlo

Just wanted to send a large thanks for the Zally project and a small notification that I created a stand-alone Maven plugin for Zally available here: https://github.com/ethlo/zally-maven-plugin

Pasan Gamaetige

@psnmissaka

Hi all,
I was trying to build the docker image for web UI and run it for production. But since Dockerfile doesn't contain explicit webpack build steps, when running a container from the built image, front-end throws a Uncaught SyntaxError: Unexpected token '<'. I think this is because it can't locate the bundle.js
I was wondering if the explicit webpack build isn't added as a step in the WEB UI Dockerfile for a specific reason?

Tronje Krop

@tkrop

Hi Pasan, I'm not sure what we do in the Web-UI build in Zally, but since we need to customize the WebUI for our company authorization, we likely have not taken enough care to make it build and run without some additional work.

Tronje Krop

@tkrop

If you find a way to simplify building a docker image and contribute it, we are fine with this.

Pasan Gamaetige

@psnmissaka

@tkrop alright sure. Currently for my requirement what I did was to create a Dockerfile for production for Web-UI with a specific build step. However, that resulted in Web-UI image size increase by ~200MB. I will see if I can optimize it further, and add a PR. Thanks!

Tronje Krop

@tkrop

Interesting aspect. I must admit, we do not care too much about the image size. Would be interesting how much of the image can share memory with similar images running in Kubernetes.

AnjaniParameswari

@AnjaniParameswari

Hi, I am new to zally and i want to make use of zally in my spring boot project.. Could you please guide me how can i start with that?

Kirill Baurchanu

@baurchanu

@AnjaniParameswari hi, if you build the project with Maven, you can use plugin written by @ethlo for failing build in case of rule violations
https://github.com/ethlo/zally-maven-plugin#usage

Kirill Baurchanu

@baurchanu

@ethlo hi, excellent, thank you. I also wrote a Maven plugin zalando/zally#1300, but didn't release it. Great that you finished and published your version

ramy-hassan

@ramy-hassan

Hello Guys, Trying to build zally but it takes too long and stuck on zally_server builder with out any errors

ramy-hassan

@ramy-hassan

found a way, buy running only server and cli

Where communities thrive

People

Repo info

Activity