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

deprecate stacks, add targets #582

Closed
wants to merge 9 commits into from

Conversation

joe-kimmel-vmw
Copy link
Contributor

@joe-kimmel-vmw joe-kimmel-vmw commented Apr 5, 2023

a pass at revising our docs for targets. hopefully provides a starting point to refine them into something we all want to publish.

#422

Copy link
Member

@AidanDelaney AidanDelaney left a comment

Choose a reason for hiding this comment

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

The content here is great. I've suggested some stylistic changes. Feel free to adopt or ignore them.

content/docs/concepts/components/stack.md Outdated Show resolved Hide resolved
content/docs/concepts/components/stack.md Outdated Show resolved Hide resolved
@AidanDelaney
Copy link
Member

In answer to your question about https://buildpacks.io/docs/operator-guide/create-a-stack/, we should remove that. The docs should reflect the current best practice. I wonder if we should trust archive.org to store our legacy docs? Or should we have a Buildpacks API dropdown at the top?

joe-kimmel-vmw and others added 5 commits April 8, 2023 14:48
Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
Co-authored-by: Aidan Delaney <aidan.delaney@gmail.com>
Signed-off-by: Joe Kimmel <86852107+joe-kimmel-vmw@users.noreply.github.com>
Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
…hade of beige

Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
@joe-kimmel-vmw joe-kimmel-vmw marked this pull request as ready for review April 8, 2023 21:49
@joe-kimmel-vmw joe-kimmel-vmw requested a review from a team as a code owner April 8, 2023 21:49
@joe-kimmel-vmw
Copy link
Contributor Author

I wonder if we should trust archive.org to store our legacy docs?

Probably safe -- it's not like a group of publishers would ever try to shut down the entire internet archive.

@joe-kimmel-vmw joe-kimmel-vmw changed the title components first pass - deprecate stacks, add targets deprecate stacks, add targets Apr 10, 2023
Co-authored-by: Jesse Brown <jabrown85@gmail.com>
Signed-off-by: Joe Kimmel <86852107+joe-kimmel-vmw@users.noreply.github.com>
## What is a Target?

A target is the essential information about an operating system and architecture necessary to ensure that binaries will be placed in environments where they can execute successfully.
A buildpack may specify one or several targets. A build image or run image must specific one target.
Copy link

Choose a reason for hiding this comment

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

This statement is confusing to me: A build image or run image must specific one target.. Does this mean [[targets]] is supposed to be nested inside the [run] and [build] blocks? I'm more familiar with yaml/json than with toml, so I tend to convert it in order to understand what is going on and it appears to be a builder-wide setting.

given this builder.toml:

[build]
image = "ghcr.io/jericop/build-jammy:target"

[run]
[[run.images]]
image = "ghcr.io/jericop/run-jammy:target"

[[targets]]
os = "linux"
arch = "amd64"
[[targets.distributions]]
name = "ubuntu"
versions = ["18.04", "20.04"]

the yaml output is:

build:
  image: ghcr.io/jericop/build-jammy:target
run:
  images:
    - image: ghcr.io/jericop/run-jammy:target
targets:
  - os: linux
    arch: amd64
    distributions:
      - name: ubuntu
        versions:
          - "18.04"
          - "20.04"

It would be helpful to have a complete example of using [[targets]] in a builder toml.

Copy link
Member

@AidanDelaney AidanDelaney left a comment

Choose a reason for hiding this comment

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

Getting closer :)

content/docs/concepts/components/stack.md Outdated Show resolved Hide resolved
content/docs/operator-guide/create-targets.md Outdated Show resolved Hide resolved
Comment on lines 44 to 53
Similarly

**Labels (optional)**

##### TODO / question: I think the spec says that "the platform" (as opposed to the build image author) should set the labels?
https://github.com/buildpacks/spec/pull/335/files#diff-e603760990971da3f77be4bb8d77c3405098f006814fd8c054d2d15f395b8330R199
should we mention them in this tutorial?
##### end TODO /question


Copy link
Member

Choose a reason for hiding this comment

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

What direction is this taking? Can I help here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm. this is wrong as -is. the "image config" doesn't get the * but the labels do, i think. maybe I can ask @natalieparellano to confirm

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, so, we said, heck with it let's just not mention it in the tutorial since it's optional anyways, and only getting more optional as the spec gets closer and closer to being released.

joe-kimmel-vmw and others added 3 commits July 26, 2023 15:44
Co-authored-by: Aidan Delaney <aidan.delaney@gmail.com>
Signed-off-by: Joe Kimmel <86852107+joe-kimmel-vmw@users.noreply.github.com>
Co-authored-by: Aidan Delaney <aidan.delaney@gmail.com>
Signed-off-by: Joe Kimmel <86852107+joe-kimmel-vmw@users.noreply.github.com>
Signed-off-by: Joe Kimmel <jkimmel@vmware.com>
@natalieparellano natalieparellano marked this pull request as draft August 9, 2023 14:45
@natalieparellano
Copy link
Member

Superseded by #618

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

Successfully merging this pull request may close these issues.

None yet

5 participants