Feedback from customer on PDF

[ranjinimn]

Hi, I have accessed the PDF version of the Edge documentation, and there are some issues at least for the last few versions of the document. For example you can take a look at https://documentation.suse.com/suse-edge/3.5/pdf/edge_en.pdf:

Images that represent diagrams aren't correct, they are missing all the text, this text is displayed correctly on the HTML page, like PDF pages 21 (xxi), 22 (xxii), 24 (xxiv), 31 (3), 55 (27).
Text that represents code goes beyond document right margin, like in pages 76 (48), 80 (52), 82 (54), 170 (142), 174 (146), 176 (148). And sometimes beyond the bottom margin and overlap the page number like pages 199 (171), 200 (172), 202 (174), 203 (175).
Screenshots are larger than page size and go beyond the right margin or the bottom margin and you cannot really see the whole screenshot that is necessary, like in pages 178 (150), 180 (152).
The pages I mention are only examples. I guess the whole PDF should be reviewed in detail since there can be more issues.
I hope it helps.

https://suse.slack.com/archives/C072TF88KNU/p1771545274219749

[ranjinimn]

@hardys This renders differently in the PDF version and runs off the page. Is there an option to replace this with anything more generic?

[fsundermeyer]

This, and the strings below, are examples if I understand it correctly. I suggest to shorten them to something like
I2Nsb3VkLW[...]Anc3VzZScK
OK with you @hardys ?

[hardys]

They are examples, but we can't just truncate them IMO, as they serve a specific purpose which is to set the username/password for the SSH login which is described below (see password is "suse")

Another option is to take the unencoded data, e.g:

#cloud-config
disable_root: false
ssh_pwauth: True
users:
  - default
  - name: suse
    groups: sudo
    shell: /bin/bash
    sudo:  ALL=(ALL) NOPASSWD:ALL
    lock_passwd: False
    plain_text_passwd: 'suse'

We could say to create that file then in the kubectl apply say $(cat cloud-config.yaml)

[ranjinimn]

Thank you for this suggestion. 2 questions:
1 . This is one of the many examples of passwords. Do we need to add do the same action for every one of them?
2. Which section would be the most appropriate to add this step?

[hardys]

It's only referenced twice so I'd probably just add it to each example e.g:

$ cat <<EOF > user-data.yaml
#cloud-config
disable_root: false
ssh_pwauth: True
users:
  - default
  - name: suse
    groups: sudo
    shell: /bin/bash
    sudo:  ALL=(ALL) NOPASSWD:ALL
    lock_passwd: False
    plain_text_passwd: 'suse'
EOF
$ kubectl apply -f - <<EOF
apiVersion: kubevirt.io/v1
kind: VirtualMachine
metadata:
  name: ingress-example
  namespace: default
spec:
  runStrategy: Always
  template:
    metadata:
      labels:
        app: nginx
    spec:
      domain:
        devices: {}
        machine:
          type: q35
        memory:
          guest: 2Gi
        resources: {}
      volumes:
      - containerDisk:
          image: quay.io/containerdisks/opensuse-tumbleweed:1.0.0
        name: tumbleweed-containerdisk-0
      - cloudInitNoCloud:
          userDataBase64: $(cat user-data.yaml)
        name: cloudinitdisk

[ranjinimn]

@hardys Should it have the EOF at the end of this code block?

$ cat <<EOF > user-data.yaml
#cloud-config
disable_root: false
ssh_pwauth: True
users:
  - default
  - name: suse
    groups: sudo
    shell: /bin/bash
    sudo:  ALL=(ALL) NOPASSWD:ALL
    lock_passwd: False
    plain_text_passwd: 'suse'
EOF
$ kubectl apply -f - <<EOF
apiVersion: kubevirt.io/v1
kind: VirtualMachine
metadata:
  name: ingress-example
  namespace: default
spec:
  runStrategy: Always
  template:
    metadata:
      labels:
        app: nginx
    spec:
      domain:
        devices: {}
        machine:
          type: q35
        memory:
          guest: 2Gi
        resources: {}
      volumes:
      - containerDisk:
          image: quay.io/containerdisks/opensuse-tumbleweed:1.0.0
        name: tumbleweed-containerdisk-0
      - cloudInitNoCloud:
          userDataBase64: $(cat user-data.yaml)
        name: cloudinitdisk
EOF

[ranjinimn]

I had to remove the number from the password as it was not breaking the text correctly in the PDF rendition. Please let me know if it's okay.

[fsundermeyer]

Again, an example string

[ranjinimn]

@hardys Can we use the string as suggested by Frank in the earlier comment?
For example:

Suggested change

	$6$G392FCbxVgnLaFw$Ujt00mdpJ3tDHxEg1snBU3GjujQf6f8kvopu7jiCBIhRbRvMmKUqwcmXAKggaSSKeUUOEtCP3ZUoZQY7zTXnC1
	$6$G392FCbxVgn[...]Y7zTXnC1

[ranjinimn]

@hardys Can you please help here ?

[ranjinimn]

same comment as above