Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating OS Package metadata: license and description #49793

Merged
merged 6 commits into from
Dec 9, 2024

Conversation

doggydogworld
Copy link
Contributor

@doggydogworld doggydogworld commented Dec 4, 2024

Updates our OS packages (.rpm, .deb, etc) metadata to be up-to-date. Previous to this change it contained out-of-date information for our license and description.

changelog: Our OSS OS packages (rpm, deb, etc) now have up-to-date metadata.

Copy link
Contributor

@fheinecke fheinecke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM provided that this builds/releases without issue

Copy link
Collaborator

@zmb3 zmb3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment.

Also note that the licensing rules changed with v16, so this should not be backported to v15.

@@ -74,9 +74,9 @@ FPM_IMAGE_RPM="public.ecr.aws/gravitational/fpm:centos8-1.15.1-1"

# extra package information for linux
MAINTAINER="info@goteleport.com"
LICENSE="Apache-2.0"
LICENSE="AGPL-3.0-or-later"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The packages we distribute are governed by build.assets/LICENSE-community, NOT by AGPLv3.

We should change this (is there a way to use a custom license in a package?), and we should also be including a copy of LICENSE-community in the package itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok the task we had wasn't entirely clear on what was necessary. Thanks for the additional context.

We should be able to use a custom license. Afaik this just takes in an arbitrary string. Unfortunately there's not really a way to query for the contents of the license itself. Maybe we could provide a link to the license in the description?

Adding the LICENSE-community should be easy enough though. Just need to update build-archive to include it in the tarball.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose its even a little more complicated than that, as the -ent packages are not governed by LICENSE-community.

@doggydogworld
Copy link
Contributor Author

Dev build: https://github.com/gravitational/teleport.e/actions/runs/12205154596#artifacts

Tarball

tar -tvf ~/Downloads/teleport-v17.0.0-dev.gus-pkg-metadata.2-darwin-amd64-bin.tar.tar
drwxr-xr-x  0 runner staff       0 Dec  6 14:02 teleport/
-rwxr-xr-x  0 runner staff    2038 Dec  6 14:02 teleport/install
-rwxr-xr-x  0 runner staff 89892224 Dec  6 14:02 teleport/tbot
...
-rw-r--r--  0 runner staff     11896 Dec  6 14:02 teleport/LICENSE-community

RPM

rpm -qip /work/teleport-17.0.0-dev.gus-pkg-metadata.2-1.arm.rpm
warning: /work/teleport-17.0.0-dev.gus-pkg-metadata.2-1.arm.rpm: Header V4 RSA/SHA512 Signature, key ID 2f67ad73: NOKEY
Name        : teleport
Version     : 17.0.0_dev.gus_pkg_metadata.2
Release     : 1
Architecture: armv7hl
Install Date: (not installed)
Group       : default
Size        : 589293987
License     : Teleport Community Edition License
Signature   : RSA/SHA512, Fri Dec  6 19:59:07 2024, Key ID 1b3d7a692f67ad73
Source RPM  : teleport-17.0.0_dev.gus_pkg_metadata.2-1.src.rpm
Build Date  : Fri Dec  6 19:57:58 2024
Build Host  : a4bf7ec79ff7
Relocations : /
Packager    : info@goteleport.com
Vendor      : Gravitational
URL         : https://goteleport.com/docs
Summary     : Teleport provides on-demand, least-privileged access to your infrastructure, on a foundation of cryptographic identity and zero trust, with built-in identity and policy governance [32-bit ARM Open source edition]\n\nDistributed under the Teleport Community Edition License
Description :
Teleport provides on-demand, least-privileged access to your infrastructure, on a foundation of cryptographic identity and zero trust, with built-in identity and policy governance [32-bit ARM Open source edition]\n\nDistributed under the Teleport Community Edition License

deb

dpkg-deb -I teleport_17.0.0-dev.gus-pkg-metadata.2_arm.deb
 new Debian package, version 2.0.
 size 158822666 bytes: control archive=1379 bytes.
     577 bytes,    12 lines      control
     419 bytes,     7 lines      md5sums
    1213 bytes,    47 lines   *  postinst             #!/bin/sh
 Package: teleport
 Version: 17.0.0-dev.gus-pkg-metadata.2
 License: Teleport Community Edition License
 Vendor: Gravitational
 Architecture: armhf
 Maintainer: info@goteleport.com
 Installed-Size: 575482
 Provides: teleport
 Section: default
 Priority: optional
 Homepage: https://goteleport.com/docs
 Description: Teleport provides on-demand, least-privileged access to your infrastructure, on a foundation of cryptographic identity and zero trust, with built-in identity and policy governance [32-bit ARM Open source edition]\n\nDistributed under the Teleport Community Edition License

@doggydogworld doggydogworld added this pull request to the merge queue Dec 9, 2024
Merged via the queue into master with commit 26dacb4 Dec 9, 2024
41 checks passed
@doggydogworld doggydogworld deleted the gus/updating-os-pkg-metadata branch December 9, 2024 19:20
@public-teleport-github-review-bot

@doggydogworld See the table below for backport results.

Branch Result
branch/v16 Create PR
branch/v17 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants