quay/config-tool

Configuration Validation Tool for Quay

Project Quay

⚠️ The master branch may be in an unstable or even broken state during development. Please use releases instead of the master branch in order to get stable software.

Project Quay builds, stores, and distributes your container images.

High-level features include:

• Docker Registry Protocol v2
• Docker Manifest Schema v2.1, v2.2
• AppC Image Discovery via on-demand transcoding
• Image Squashing via on-demand transcoding
• Authentication provided by LDAP, Keystone, OIDC, Google, and GitHub
• ACLs, team management, and auditability logs
• Geo-replicated storage provided by local filesystems, S3, GCS, Swift, and Ceph
• Continuous Integration integrated with GitHub, Bitbucket, GitLab, and git
• Security Vulnerability Analysis via Clair
• Swagger-compliant HTTP API

Getting Started

• Explore a live instance of Project Quay hosted at Quay.io
• Watch talks given about Project Quay
• Review the documentation for Red Hat Quay
• Get up and running with our getting started guide for developing or deploying Quay
• Deploy on Kubernetes using the Quay Operator

Community

• Mailing List: [email protected]
• IRC: #quay on libera.chat
• Bug tracking: JBoss JIRA
• Security Issues: [email protected]
• Community meetings held the first Wednesday of every month 11:00 AM EST: meeting link

License

Project Quay is under the Apache 2.0 license. See the LICENSE file for details.

config-tool's Issues

How to create\deploy bundles.

The documentation states "Once a config bundle has been successfully validated, we can use a third endpoint to bundle our config into a tar.gz."

The directions does not show the how to actually bundle the config in to a tar.gz. How is this accomplished?

I attempted to pull the api info hitting {{host}}/swagger/index.html, but I get
"Fetch error" - "Not Found /docs/swagger.json"

How do you interact with the API to build/deploy the tar.gz?

config-tool fails on some secure passwords

Quay: v3.4.0
config-tool v0.1.0
Red Hat Enterprise Linux release 8.3 (Ootpa)

Quay container won't start after upgrade to Quay v3.4.0 caused by some trouble with config-tool

$ config-tool validate -c /quay-registry/conf/stack/ --mode online
panic: runtime error: slice bounds out of range [1:0]
goroutine 24 [running]:
github.com/quay/config-tool/pkg/lib/fieldgroups/database.ValidateDatabaseConnection(0x7ffd55ca9661, 0x6, 0xc0004a9980, 0xc0001882d0, 0x0, 0x0, 0x0, 0x0)
        /remote-source/app/source/config-tool/pkg/lib/fieldgroups/database/database_validator.go:90 +0xca5
github.com/quay/config-tool/pkg/lib/fieldgroups/database.(*DatabaseFieldGroup).Validate(0xc000450fc0, 0x7ffd55ca9661, 0x6, 0xc0004a9980, 0xc0002a7848, 0x0, 0x0)
        /remote-source/app/source/config-tool/pkg/lib/fieldgroups/database/database_validator.go:55 +0x22a
github.com/quay/config-tool/commands.glob..func3.1(0xc0004a97a0, 0xc0004e2cd0, 0xc0004a9980, 0xc000451700, 0xc00040e222, 0xc00040eea0)
        /remote-source/app/source/config-tool/commands/validate.go:108 +0xd4
created by github.com/quay/config-tool/commands.glob..func3
        /remote-source/app/source/config-tool/commands/validate.go:93 +0x4eb

It seems DB_URI contains some problematic content in secure database password. The problematic sign is "?"
After removing this, config-tool works well. Of course I have to change the password in database backend ;-)
Thanks!

Swift storage connection configuration is wrong

Hi,
I have been trying to deploy Quay on an environment which has swift as storage option and the config validator fails even though quay itself is working fine with the backend storage after bypassing the validator.
When looking at the source code here I noticed that the swift connection parameter isn't up to date with the upstream ncw/swift module:

config-tool/pkg/lib/shared/storage_validators.go

Line 451 in 673209c

c = swift.Connection{

Here you can see the tenant option is missing as per documentation :
https://github.com/ncw/swift/blob/master/README.md

I have locally changed the config tool code and the connection works as expected when the tenant name is provided.
I hope this info helps.

Thanks