Prepare AWS Marketplace listing docs — verified API publish path (#220)#221
Merged
Conversation
Port the verified AWS Marketplace listing patterns from the live Elevarq pgAgroal launch into the Signals marketplace docs. Docs prep only — no AWS calls, nothing released; the v1.0.0 release + EULA legal sign-off stay GATED. - EULA.md: clean customer-facing contract only (Draft/counsel/recommended- option blocks removed). "No fees" -> "No software fee" (buyer pays AWS infra/service charges). Data section clarified (local-first, read-only; no telemetry/diagnostic-data egress to Elevarq; only outbound calls are the optional cloud-auth/TLS requests within the buyer's own cloud; Marketplace/ subscription data governed by AWS terms). Commercial-support upsell removed — community support via GitHub Issues, security via SECURITY.md / security@elevarq.com. - EULA-review-notes.md (new): custom-EULA-vs-SCMP rationale, Scantr LLC d/b/a Elevarq entity gate, seller-entity / EULA-party / LICENSE-copyright alignment, CustomEula S3-PDF plan. - catalog-api/README.md + aws-listing.md: replace the "portal-only first publish" framing with the verified fully-Catalog-API-driven sequence (CreateProduct/AddRepositories -> UpdateInformation -> CreateOffer + legal CustomEula + support terms, no pricing term for a free offer -> ReleaseProduct+ReleaseOffer combined -> AddDeliveryOptions -> UpdateVisibility Public). Fold in S3 LogoUrl (reuse the Elevarq company logo), CustomEula S3 PDF, docker buildx imagetools re-host (drop skopeo), the ECR chart-path 403 gotcha, the inert metering SignatureVerificationKey, and the ListEntities / describe-change-set --query quirks. - catalog-api/03-update-information.json (new): benefit-first listing copy — short + long description, 3 highlights, 14 keywords (120 combined chars), Infrastructure Software category, S3 LogoUrl. - install-from-aws-marketplace.md: chart URI lands at the granted ECR repo (no hierarchical sub-path). - marketplace-ecr-push.sh: buildx imagetools (not skopeo); fix the chart-path 403 (rename chart to the repo's last segment, push to the parent namespace). Signals keys resource names off the Helm release name, so no nameOverride is needed (unlike pgAgroal). Refs #218
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ports the VERIFIED AWS Marketplace listing patterns from the live Elevarq pgAgroal launch into the Signals marketplace docs. Docs prep only — no AWS CLI / change-sets were run, nothing is released, and the v1.0.0 release + EULA legal sign-off stay GATED.
What changed
docs/marketplace/EULA.md— reduced to clean customer-facing contract text only (removed the Draft / for-counsel / recommended-option blocks). Content fixes: "no fees" -> "no software fee" (buyer still pays AWS infra/service charges); data section clarified (local-first, read-only; no telemetry/diagnostic-data egress to Elevarq as packaged; the only outbound calls are the optional cloud-auth/TLS requests within the buyer's own cloud; Marketplace/subscription data governed by AWS terms); commercial-support upsell removed in favour of community support via GitHub Issues + security viaSECURITY.md/ security@elevarq.com.docs/marketplace/EULA-review-notes.md(new) — internal rationale + counsel gates (custom-EULA-vs-SCMP, Scantr LLC d/b/a Elevarq entity gate, seller-entity / EULA-party /LICENSE-copyright alignment, CustomEula S3-PDF plan).docs/marketplace/catalog-api/README.md+docs/marketplace/aws-listing.md— replaced the "portal-only first publish" framing with the verified fully Catalog-API-driven sequence: CreateProduct + AddRepositories -> UpdateInformation (incl. S3 LogoUrl, works on Draft) -> CreateOffer + offer UpdateInformation + UpdateLegalTerms(CustomEula) + UpdateSupportTerms (no pricing term for a free offer) -> ReleaseProduct + ReleaseOffer (combined, Draft->Limited) -> AddDeliveryOptions (only once Limited; triggers the AWS scan) -> UpdateVisibility:Public (own change-set; Seller-Ops manual review; needs a public seller profile). Folded in: S3 LogoUrl reuse of the Elevarq company logo, CustomEula S3 PDF,docker buildx imagetools createre-host (skopeo dropped), the ECR chart-path 403 gotcha, the inert meteringSignatureVerificationKey, and theListEntities(Offerno@version) /describe-change-set --queryquirks.docs/marketplace/catalog-api/03-update-information.json(new) — benefit-first listing copy: short + long description (lead with local-first / read-only / passwordless / no diagnostic-data egress), 3 highlights, 14 keywords (120 combined chars),Infrastructure Softwarecategory (AWS has no "Database" category), S3 LogoUrl.docs/marketplace/install-from-aws-marketplace.md— buyer chart URI now lands at the granted ECR repo (no hierarchical…/signalssub-path).scripts/marketplace-ecr-push.sh— aligned with the corrected docs so they don't drift:docker buildx imagetools createinstead of skopeo (which the verified learning says is not installed), and the chart-path 403 fix (rename the chart to the repo's last segment, push to the parent namespace). shellcheck-clean.Signals-specific accuracy
Signals is a read-only diagnostic collector, not a connection pooler — pgAgroal's product specifics were not copied. One notable divergence: the Signals Helm chart derives resource names from the Helm release name (
{{ .Release.Name }}-signals), not.Chart.Name, so renaming the chart artifact to fix the 403 needs nonameOverride(pgAgroal needed one).Gating
Signals is still pre-1.0 (
v0.10.0-rc.1). The listing is gated on the v1.0.0 release and EULA legal sign-off; this PR changes documentation only.Refs #218
closes #220