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

IBX-3767: Document how to use fastly CLI on post deploy hook #57

Merged
merged 2 commits into from
Jan 11, 2023
Merged

Conversation

Nattfarinn
Copy link
Contributor

Question Answer
JIRA issue Ref. to: https://issues.ibexa.co/browse/IBX-3767
Type improvement
Target Ibexa version v4.3
BC breaks no

Checklist:

  • Checked that target branch is set correctly (main for features, the oldest supported for bugs).
  • Asked for a review (ping @ibexa/engineering).

@adamwojs
Copy link
Member

adamwojs commented Jan 9, 2023

You can rebase PR @Nattfarinn. #58 has been merged.

@adamwojs adamwojs requested review from vidarl and a team January 11, 2023 08:40
@webhdx webhdx merged commit 261c2b9 into 4.3 Jan 11, 2023
@webhdx webhdx deleted the ibx-3767 branch January 11, 2023 09:49
Copy link
Contributor

@vidarl vidarl left a comment

Choose a reason for hiding this comment

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

Is is really desirable to put this kind of documentation in the .platform.app.yaml file ?
On Ibexa Cloud, p.sh will (are at least supposed to ) install the .vcl and snippets during onboarding. p.sh want to avoid doing any further updates it after that, so it is good that we have some documentation on how to use Fastly CLI though.

I think the better place is doc.ibexa.co. I have this PR pending btw to improve Fastly documentation, but it does not address Fastly CLI : https://github.com/ezsystems/developer-documentation/pull/1848/files.
Not all Fastly users are necessarily on Ibexa Cloud, so I think it is important to not have the Fastly doc only in p.sh context

I don't think it hurts to have it both here and on doc.ibexa.co though, but there are then two places to maintain in regards to changes.

For instance, when Fastly-IO will be supported shortly

@DominikaK

# Official documentation on how to install: https://developer.fastly.com/learning/tools/cli#installing
# Example VCL snippet upload using vcl_recv hook (remember about FASTLY_SERVICE_ID and FASTLY_KEY environmental variables):
##fastly vcl custom create --name="Ibexa VCL" --main --version=latest --autoclone --content=vendor/ibexa/fastly/fastly/ez_main.vcl
##fastly vcl snippet create --name="Shielding" --version=active --autoclone --type recv --content=vendor/ibexa/fastly/fastly/snippet_re_enable_shielding.vcl
Copy link
Contributor

Choose a reason for hiding this comment

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

Info about fastly/ez_user_hash.vcl is missing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is just example of how to use Fastly CLI in general, not how to enable and configure Fastly on our side. :)

Copy link

@lserwatka lserwatka Jan 11, 2023

Choose a reason for hiding this comment

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

Can we get rid of ez_ prefix?

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.

8 participants